From 273b28bdfddd6a557f9de6fc156b8365f951077d Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Thu, 30 Apr 2026 21:42:14 +0200 Subject: [PATCH 01/10] feat: emit CLI structure as argh-schema JSON via `elastic cli-schema` Adds a `cli-schema` command and `npm run build:schema` script that walk the full Commander command tree and emit the CLI structure as a checked-in JSON artifact (docs/cli/schema.json) conforming to the argh CLI schema format. Key design choices: - `src/namespaces.ts` is the single source of truth for top-level namespace registration; adding a new namespace only requires one edit - `src/factory.ts` attaches `_commandConfig` (typed options + Zod schema + schemaArgs) to every leaf command so the emitter can recover full type/validation metadata without re-parsing Commander strings - ES API schemas are loaded eagerly only for `cli-schema`; all other invocations retain the existing lazy-load optimisation - Per-parameter fields emitted: `type`, `defaultValue`, `repeatable`, `separator`, `enumValues` (from Zod), `elementType`, `hidden` - Enum choices and array element types are extracted via the same `z.toJSONSchema()` call already used by `--help --json` Co-Authored-By: Claude Sonnet 4.6 (1M context) --- docs/cli/configuration.md | 166 + docs/cli/index.md | 3 + docs/cli/installation.md | 17 + docs/cli/schema.json | 106549 +++++++++++++++++++++++++++++++++++ docs/docset.yml | 10 + docs/index.md | 3 + package.json | 1 + src/cli-schema.ts | 479 + src/cli.ts | 10 +- src/es/register.ts | 11 + src/factory.ts | 11 +- src/namespaces.ts | 79 + test/factory.test.ts | 2 +- 13 files changed, 107338 insertions(+), 3 deletions(-) create mode 100644 docs/cli/configuration.md create mode 100644 docs/cli/index.md create mode 100644 docs/cli/installation.md create mode 100644 docs/cli/schema.json create mode 100644 docs/docset.yml create mode 100644 docs/index.md create mode 100644 src/cli-schema.ts create mode 100644 src/namespaces.ts diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md new file mode 100644 index 0000000..6a36027 --- /dev/null +++ b/docs/cli/configuration.md @@ -0,0 +1,166 @@ +# Configuration + +The CLI looks for a config file in your home directory. The following file names are checked in order: + +1. `.elasticrc` +2. `.elasticrc.json` +3. `.elasticrc.yaml` +4. `.elasticrc.yml` + +Place your config at `~/.elasticrc.yml` (recommended). To use a file in a different location, pass `--config-file ` or set `ELASTIC_CLI_CONFIG_FILE`. The flag takes precedence over the environment variable. + +```yaml +current_context: local + +contexts: + local: + elasticsearch: + url: http://localhost:9200 + auth: + api_key: your-api-key-here + kibana: + url: http://localhost:5601 + auth: + api_key: your-api-key-here + staging: + elasticsearch: + url: https://my-cluster.es.us-east-1.aws.elastic.cloud + auth: + api_key: your-api-key-here + cloud: + url: https://api.elastic-cloud.com + auth: + api_key: your-cloud-api-key-here +``` + +Multiple contexts are supported. Override `current_context` for a single command with `--use-context `. + +Each context can have any combination of service blocks (`elasticsearch`, `kibana`, `cloud`). Authentication supports `api_key` or `username` + `password`. + +## Authoring the config from the CLI + +Instead of hand-editing YAML, the `elastic config` command group creates and maintains contexts and stores secrets in the OS keychain when available (macOS Keychain, Linux libsecret, `pass`, Windows Credential Manager). The YAML then holds a resolver expression like `$(keychain:...)` rather than the raw secret. + +```bash +# Add a new context (API key goes to the keychain) +elastic config context add local \ + --es-url http://localhost:9200 \ + --es-api-key your-api-key + +# List contexts +elastic config context list + +# Switch the active context +elastic config current-context set staging + +# Patch an existing context +elastic config context edit local --es-url http://localhost:9201 + +# Open the context as YAML in $EDITOR +elastic config context edit local + +# Remove a context (keychain entries are cleaned up) +elastic config context remove old-lab +``` + +If no OS keychain is available or you pass `--inline-secrets`, the secret is written inline and the file is `chmod 0600`. A warning is emitted when a loaded config has inline secrets at looser-than-0600 permissions. + +## Credential-safe project creation + +For agent and LLM workflows, `serverless projects create` and `reset-credentials` accept `--save-as ` to avoid leaking admin credentials through stdout: + +```bash +elastic cloud serverless es projects create --wait --save-as scratch \ + --name scratch-es --region-id aws-us-east-1 + +# stdout has endpoints + a `savedAs: scratch` marker, password is redacted. +# The keychain now holds scratch:elasticsearch.auth.password etc. +elastic --use-context scratch stack es indices list + +# Rotate credentials; URL stays, only the password moves. +elastic cloud serverless es projects reset-credentials --id \ + --save-as scratch --force +``` + +`--credentials-file ` writes a standalone YAML config fragment (0600) at `` instead of mutating the main config. Either flag makes stdout safe to capture into an LLM transcript. + +## External credentials + +Any string value in the config file can use `$(resolver:params)` expressions to fetch secrets from external sources at runtime. + +:::{warning} +Review config files before using them if you didn't write them yourself. The `$(cmd:...)` and `$(file:...)` resolvers execute programs and read files on your behalf. This applies especially to CI/CD environments where a repo-checked-in config (e.g. via `ELASTIC_CLI_CONFIG_FILE`) can run arbitrary commands on the runner. +::: + +`file` +: Reads the contents of a file (trimmed). Useful for Docker/Kubernetes secrets mounted at `/run/secrets/`. + + ```yaml + auth: + api_key: $(file:/run/secrets/elastic_api_key) + ``` + +`env` +: Reads an environment variable. + + ```yaml + auth: + api_key: $(env:ELASTIC_API_KEY) + ``` + +`cmd` +: Executes a shell command and uses its stdout (trimmed) as the value. + + ```yaml + auth: + api_key: $(cmd:pass show elastic/api-key) + ``` + +`keychain` *(macOS only)* +: Reads a password from the macOS Keychain using `service/account` format. + + ```yaml + auth: + api_key: $(keychain:elastic-cli/api-key) + ``` + + To store a value: `security add-generic-password -s elastic-cli -a api-key -w` + +`secret_service` *(Linux only)* +: Reads a secret from GNOME Keyring or KWallet via `secret-tool`. + + ```yaml + auth: + api_key: $(secret_service:elastic-cli/api-key) + ``` + + To store a value: `secret-tool store --label='Elastic API Key' service elastic-cli account api-key` + +`pass` *(cross-platform)* +: Reads the first line from `pass show`. Works on Linux, macOS, and Windows (WSL). + + ```yaml + auth: + api_key: $(pass:elastic/api-key) + ``` + + To store a value: `pass insert elastic/api-key` + +`credential_manager` *(Windows only)* +: Reads a credential from Windows Credential Manager. Requires the `CredentialManager` PowerShell module. + + ```yaml + auth: + api_key: $(credential_manager:elastic-cli/api-key) + ``` + + To store a value: `New-StoredCredential -Target elastic-cli/api-key -UserName _ -Password ` + +Expressions can appear in any string field, including URLs: + +```yaml +elasticsearch: + url: https://$(env:ES_HOST):9200 + auth: + api_key: $(keychain:elastic-cli/api-key) +``` diff --git a/docs/cli/index.md b/docs/cli/index.md new file mode 100644 index 0000000..7cf4e20 --- /dev/null +++ b/docs/cli/index.md @@ -0,0 +1,3 @@ +Interact with the Elastic Stack and Elastic Cloud from the command line. + +Configure the CLI with `elastic config context add` to connect to your Elasticsearch, Kibana, and Elastic Cloud endpoints. See [Installation](./installation.md) and [Configuration](./configuration.md) to get started. diff --git a/docs/cli/installation.md b/docs/cli/installation.md new file mode 100644 index 0000000..77c79a0 --- /dev/null +++ b/docs/cli/installation.md @@ -0,0 +1,17 @@ +# Installation + +The `elastic` CLI is not yet available on npm. Install it by cloning the repository, building, and linking it locally. + +```bash +git clone git@github.com:elastic/cli.git +cd cli +npm install +npm run build +npm link +``` + +Once linked, verify the installation: + +```bash +elastic --help +``` diff --git a/docs/cli/schema.json b/docs/cli/schema.json new file mode 100644 index 0000000..96857fa --- /dev/null +++ b/docs/cli/schema.json @@ -0,0 +1,106549 @@ +{ + "schemaVersion": "1", + "name": "elastic", + "version": "0.1.0-alpha.1", + "description": "Interface with the Elastic Stack and Elastic Cloud from the command line.", + "reservedMetaCommands": [ + "cli-schema" + ], + "globalOptions": [ + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a config file (default: ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "use-context", + "shortName": null, + "type": "string", + "required": false, + "summary": "override the active context from the config file", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "json", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "output as JSON", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "output-fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "comma-separated list of fields to include in output (dot-notation supported)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "output-template", + "shortName": null, + "type": "string", + "required": false, + "summary": "Mustache-like template for custom text output (e.g. \"{{id}}: {{name}}\")", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "rootDefault": null, + "commands": [ + { + "path": [], + "name": "version", + "summary": "Print the elastic CLI version", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [ + { + "segment": "stack", + "summary": "Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "es", + "summary": "Interact with the Elasticsearch API", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es" + ], + "name": "bulk", + "summary": "Bulk index or delete documents.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of the data stream, index, or index alias to perform bulk actions on.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-source-on-error", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "True or false if to include the document source in the error message in case of parsing errors.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-executed-pipelines", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response will include the ingest pipelines that were run for each index or create.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pipeline", + "shortName": null, + "type": "string", + "required": false, + "summary": "The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value that is used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "require-alias", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request's actions must target an index alias.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "require-data-stream", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request's actions must target a data stream (existing or to be created).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "operations", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "clear-scroll", + "summary": "Clear a scrolling search.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "scroll-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The scroll IDs to clear. To clear all scroll IDs, use `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "close-point-in-time", + "summary": "Close a point in time.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the point-in-time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "count", + "summary": "Count search results.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzer", + "shortName": null, + "type": "string", + "required": false, + "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyze-wildcard", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "default-operator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "df", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-throttled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, concrete, expanded, or aliased indices are ignored when frozen.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lenient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "min-score", + "shortName": null, + "type": "number", + "required": false, + "summary": "The minimum `_score` value that documents must have to be included in the result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. By default, it is random.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "terminate-after", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "q", + "shortName": null, + "type": "string", + "required": false, + "summary": "The query in Lucene query string syntax. This parameter cannot be used with a request body.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the search query using Query DSL. A request body query cannot be used with the `q` query string parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "create", + "summary": "Create a new document in the index.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn’t match a data stream template, this request creates the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-source-on-error", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "True or false if to include the document source in the error message in case of parsing errors.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pipeline", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "require-alias", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the destination must be an index alias.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "require-data-stream", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request's actions must target a data stream (existing or to be created).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value that is used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Elasticsearch waits for at least the specified timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "The explicit version number for concurrency control. It must be a non-negative long number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "document", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "delete", + "summary": "Delete a document.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique identifier for the document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the target index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "if-primary-term", + "shortName": null, + "type": "number", + "required": false, + "summary": "Only perform the operation if the document has this primary term.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "if-seq-no", + "shortName": null, + "type": "number", + "required": false, + "summary": "Only perform the operation if the document has this sequence number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for active shards. This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs. Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation. By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "An explicit version number for concurrency control. It must match the current version of the document for the request to succeed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The minimum number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "delete-by-query", + "summary": "Delete documents.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzer", + "shortName": null, + "type": "string", + "required": false, + "summary": "Analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyze-wildcard", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "conflicts", + "shortName": null, + "type": "string", + "required": false, + "summary": "What to do if delete by query hits version conflicts: `abort` or `proceed`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "default-operator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "df", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of documents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lenient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. This is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed. Unlike the delete API, it does not support `wait_for`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "request-cache", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request cache is used for this request. Defaults to the index-level setting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "requests-per-second", + "shortName": null, + "type": "number", + "required": false, + "summary": "The throttle for this request in sub-requests per second.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "q", + "shortName": null, + "type": "string", + "required": false, + "summary": "A query in the Lucene query string syntax.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to retain the search context for scrolling.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The size of the scroll request that powers the operation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The explicit timeout for each search request. It defaults to no timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slices", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of slices this task should be divided into.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stats", + "shortName": null, + "type": "array", + "required": false, + "summary": "The specific `tag` of the request for logging and statistical purposes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "terminate-after", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period each deletion request waits for active shards.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, returns the document version as part of a hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` value controls how long each write request waits for unavailable shards to become available.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/{taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-docs", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of documents to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "The documents to delete specified with Query DSL.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slice", + "shortName": null, + "type": "object", + "required": false, + "summary": "Slice the request manually using the provided slice ID and total number of slices.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "A sort object that specifies the order of deleted documents.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "delete-script", + "summary": "Delete a script or search template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the stored script or search template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The 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. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "exists", + "summary": "Check a document.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique document identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with \"jumping values\" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realtime", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request is real-time as opposed to near-real-time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stored-fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "exists-source", + "summary": "Check for a document source.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique identifier for the document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realtime", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request is real-time as opposed to near-real-time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude in the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "explain", + "summary": "Explain a document match result.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The document identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Index names that are used to limit the request. Only a single index name can be provided to this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzer", + "shortName": null, + "type": "string", + "required": false, + "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyze-wildcard", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "default-operator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "df", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lenient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "`True` or `false` to return the `_source` field or not or a list of fields to return.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stored-fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of stored fields to return in the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "q", + "shortName": null, + "type": "string", + "required": false, + "summary": "The query in the Lucene query string syntax.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the search definition using the Query DSL.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "field-caps", + "summary": "Get the field capabilities.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-unmapped", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, unmapped fields are included in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filters", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of filters to apply to the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "types", + "shortName": null, + "type": "array", + "required": false, + "summary": "A comma-separated list of field types to include. Any fields that do not match one of these types will be excluded from the results. It defaults to empty, meaning that all field types are returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-empty-fields", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If false, empty fields are not included in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "Filter indices if the provided query rewrites to `match_none` on every shard. IMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request. For instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range. However, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "get", + "summary": "Get a document by its ID.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique document identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the index that contains the document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with \"jumping values\" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realtime", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request is real-time as opposed to near-real-time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-exclude-vectors", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether vectors should be excluded from _source", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stored-fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. Only leaf fields can be retrieved with the `stored_fields` option. Object fields can't be returned; if specified, the request fails.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "get-script", + "summary": "Get a script or search template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the stored script or search template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "get-source", + "summary": "Get a document's source.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique document identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the index that contains the document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realtime", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request is real-time as opposed to near-real-time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude in the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "index", + "summary": "Create or update a document in an index.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index. You can check for existing targets with the resolve index API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "if-primary-term", + "shortName": null, + "type": "number", + "required": false, + "summary": "Only perform the operation if the document has this primary term.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "if-seq-no", + "shortName": null, + "type": "number", + "required": false, + "summary": "Only perform the operation if the document has this sequence number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-source-on-error", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "True or false if to include the document source in the error message in case of parsing errors.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "op-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pipeline", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value that is used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "An explicit version number for concurrency control. It must be a non-negative long number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "require-alias", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the destination must be an index alias.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "require-data-stream", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request's actions must target a data stream (existing or to be created).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "document", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "info", + "summary": "Get cluster info.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "mget", + "summary": "Get multiple documents.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the node or shard the operation should be performed on. Random by default.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realtime", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request is real-time as opposed to near-real-time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request refreshes relevant shards before retrieving documents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "Custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "True or false to return the `_source` field or not, or a list of fields to return.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stored-fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "docs", + "shortName": null, + "type": "array", + "required": false, + "summary": "The documents you want to retrieve. Required if no index is specified in the request URI.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "msearch", + "summary": "Run multiple searches.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams, indices, and index aliases to search.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ccs-minimize-roundtrips", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-throttled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, concrete, expanded or aliased indices are ignored when frozen.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-named-queries-score", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-concurrent-searches", + "shortName": null, + "type": "number", + "required": false, + "summary": "Maximum number of concurrent searches the multi search API can execute. Defaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-concurrent-shard-requests", + "shortName": null, + "type": "number", + "required": false, + "summary": "Maximum number of concurrent shard requests that each sub-search request executes per node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pre-filter-shard-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rest-total-hits-as-int", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "Custom routing value used to route search operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Indicates whether global term and document frequencies should be used when scoring returned documents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "typed-keys", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "searches", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "msearch-template", + "summary": "Run multiple templated searches.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ccs-minimize-roundtrips", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, network round-trips are minimized for cross-cluster search requests.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-concurrent-searches", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of concurrent searches the API can run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of the search operation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rest-total-hits-as-int", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "typed-keys", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response prefixes aggregation and suggester names with their respective types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-templates", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "mtermvectors", + "summary": "Get multiple term vectors.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of the index that contains the documents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-statistics", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "offsets", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes term offsets.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "payloads", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes term payloads.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "positions", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes term positions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realtime", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the request is real-time as opposed to near-real-time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "term-statistics", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the response includes term frequency and document frequency.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "If `true`, returns the document version as part of a hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "docs", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of existing or artificial documents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A simplified syntax to specify documents by their ID if they're in the same index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "open-point-in-time", + "summary": "Open a point in time.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-alive", + "shortName": null, + "type": "string", + "required": true, + "summary": "Extend the length of time that the point in time persists.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. By default, it is random.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value that is used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-partial-search-results", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. If `true`, the point in time will contain all the shards that are available at the time of the request.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-concurrent-shard-requests", + "shortName": null, + "type": "number", + "required": false, + "summary": "Maximum number of concurrent shard requests that each sub-search request executes per node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "Filter indices if the provided query rewrites to `match_none` on every shard.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "ping", + "summary": "Ping the cluster.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "put-script", + "summary": "Create or update a script or search template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the stored script or search template. It must be unique within the cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "context", + "shortName": null, + "type": "string", + "required": false, + "summary": "The context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The 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. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script", + "shortName": null, + "type": "object", + "required": true, + "summary": "The script or search template, its parameters, and its language.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "rank-eval", + "summary": "Evaluate ranked search results.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search operation type", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "requests", + "shortName": null, + "type": "array", + "required": true, + "summary": "A set of typical search requests, together with their provided ratings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": "object", + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "metric", + "shortName": null, + "type": "object", + "required": false, + "summary": "Definition of the evaluation metric to calculate.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "reindex", + "summary": "Reindex documents.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request refreshes affected shards to make this operation visible to search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "requests-per-second", + "shortName": null, + "type": "number", + "required": false, + "summary": "The throttle for this request in sub-requests per second. By default, there is no throttle.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period of time that a consistent view of the index should be maintained for scrolled search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slices", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of slices this task should be divided into. It defaults to one slice, which means the task isn't sliced into subtasks. Reindex supports sliced scroll to parallelize the reindexing process. This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts. NOTE: Reindexing from remote clusters does not support manual or automatic slicing. If set to `auto`, Elasticsearch chooses the number of slices to use. This setting will use one slice per shard, up to a certain limit. If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. By default, Elasticsearch waits for at least one minute before failing. The actual wait time could be longer, particularly when multiple waits occur.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard copies that must be active before proceeding with the operation. Set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value is one, which means it waits for each primary shard to be active.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request blocks until the operation is complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "require-alias", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the destination must be an index alias.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "conflicts", + "shortName": null, + "type": "string", + "required": false, + "summary": "Indicates whether to continue reindexing even when there are conflicts.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dest", + "shortName": null, + "type": "object", + "required": true, + "summary": "The destination you are copying to.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-docs", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of documents to reindex. By default, all documents are reindexed. If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation. If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script", + "shortName": null, + "type": "object", + "required": false, + "summary": "The script to run to update the document source or metadata when reindexing.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "object", + "required": true, + "summary": "The source you are copying from.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "render-search-template", + "summary": "Render a search template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "file", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "object", + "required": false, + "summary": "Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "string", + "required": false, + "summary": "An inline search template. It supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "scripts-painless-execute", + "summary": "Run a script.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "context", + "shortName": null, + "type": "string", + "required": false, + "summary": "The context that the script should run in. NOTE: Result ordering in the field contexts is not guaranteed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "context-setup", + "shortName": null, + "type": "object", + "required": false, + "summary": "Additional parameters for the `context`. NOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script", + "shortName": null, + "type": "object", + "required": false, + "summary": "The Painless script to run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "scroll", + "summary": "Run a scrolling search.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "rest-total-hits-as-int", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to retain the search context for scrolling.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The scroll ID of the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "search", + "summary": "Run a search.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-partial-search-results", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true` and there are shard request timeouts or shard failures, the request returns partial results. If `false`, it returns an error with no partial results. To override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzer", + "shortName": null, + "type": "string", + "required": false, + "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyze-wildcard", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batched-reduce-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard results that should be reduced at once on the coordinating node. If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ccs-minimize-roundtrips", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "default-operator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default operator for the query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "df", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-throttled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-named-queries-score", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes the score contribution from any named queries. This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lenient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-concurrent-shard-requests", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of concurrent shard requests per node that the search runs concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: * `_only_local` to run the search only on shards on the local node. * `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method. * `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method. * `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method. * `_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`. * `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pre-filter-shard-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: * The request targets more than 128 shards. * The request targets one or more read-only index. * The primary sort of the query targets an indexed field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "request-cache", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the caching of search results is enabled for requests where `size` is `0`. It defaults to index level settings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value that is used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to retain the search context for scrolling. By default, this value cannot exceed `1d` (24 hours). You can change this limit by using the `search.max_keep_alive` cluster-level setting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Indicates how distributed term frequencies are calculated for relevance scoring.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use for suggestions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest-mode", + "shortName": null, + "type": "string", + "required": false, + "summary": "The suggest mode. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of suggestions to return. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest-text", + "shortName": null, + "type": "string", + "required": false, + "summary": "The source text for which the suggestions should be returned. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "typed-keys", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rest-total-hits-as-int", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-exclude-vectors", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether vectors should be excluded from _source", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "q", + "shortName": null, + "type": "string", + "required": false, + "summary": "A query in the Lucene query string syntax. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. IMPORTANT: This parameter overrides the query parameter in the request body. If both parameters are specified, documents matching the query request body parameter are not returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggregations", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the aggregations that are run as part of the search request.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggs", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the aggregations that are run as part of the search request.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "collapse", + "shortName": null, + "type": "object", + "required": false, + "summary": "Collapses search results the values of the specified field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "explain", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request returns detailed information about score computation as part of a hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ext", + "shortName": null, + "type": "object", + "required": false, + "summary": "Configuration of search extensions defined by Elasticsearch plugins.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "highlight", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "track-total-hits", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indices-boost", + "shortName": null, + "type": "array", + "required": false, + "summary": "Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "docvalue-fields", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of wildcard (`*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "knn", + "shortName": null, + "type": "object", + "required": false, + "summary": "The approximate kNN search to run.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rank", + "shortName": null, + "type": "object", + "required": false, + "summary": "The Reciprocal Rank Fusion (RRF) to use.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "min-score", + "shortName": null, + "type": "number", + "required": false, + "summary": "The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results and results collected by aggregations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "post-filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "profile", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "The search definition using the Query DSL.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rescore", + "shortName": null, + "type": "string", + "required": false, + "summary": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "retriever", + "shortName": null, + "type": "object", + "required": false, + "summary": "A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script-fields", + "shortName": null, + "type": "object", + "required": false, + "summary": "Retrieve a script evaluation (based on different fields) for each hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "array", + "required": false, + "summary": "Used to retrieve the next page of hits using a set of sort values from the previous page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slice", + "shortName": null, + "type": "object", + "required": false, + "summary": "Split a scrolled search into multiple slices that can be consumed independently.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of : pairs.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. If the `stored_fields` property is specified, the `_source` property defaults to `false`. Otherwise, it defaults to `true`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of wildcard (`*`) field patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines a suggester that provides similar looking terms based on a provided text.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "terminate-after", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "track-scores", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, calculate and return document scores, even if the scores are not used for sorting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request returns the document version as part of a hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "seq-no-primary-term", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stored-fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` property defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pit", + "shortName": null, + "type": "object", + "required": false, + "summary": "Limit the search to a point in time (PIT). If you provide a PIT, you cannot specify an `` in the request path.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "One or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stats", + "shortName": null, + "type": "array", + "required": false, + "summary": "The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "search-mvt", + "summary": "Search a vector tile.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A list of indices, data streams, or aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. To search a remote cluster, use the `:` syntax.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field", + "shortName": null, + "type": "string", + "required": true, + "summary": "A field that contains the geospatial data to return. It must be a `geo_point` or `geo_shape` field. The field must have doc values enabled. It cannot be a nested field. NOTE: Vector tiles do not natively support geometry collections. For `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection. This behavior may change in a future release.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "zoom", + "shortName": null, + "type": "number", + "required": true, + "summary": "The zoom level of the vector tile to search. It accepts `0` to `29`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "x", + "shortName": null, + "type": "number", + "required": true, + "summary": "The X coordinate for the vector tile to search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "y", + "shortName": null, + "type": "number", + "required": true, + "summary": "The Y coordinate for the vector tile to search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggs", + "shortName": null, + "type": "object", + "required": false, + "summary": "Sub-aggregations for the geotile_grid. It supports the following aggregation types: - `avg` - `boxplot` - `cardinality` - `extended stats` - `max` - `median absolute deviation` - `min` - `percentile` - `percentile-rank` - `stats` - `sum` - `value count` The aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "buffer", + "shortName": null, + "type": "number", + "required": false, + "summary": "The size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exact-bounds", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the meta layer's feature is the bounding box of the tile. If `true`, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. The aggregation runs on values that intersect the `//` tile with `wrap_longitude` set to `false`. The resulting bounding box may be larger than the vector tile.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "extent", + "shortName": null, + "type": "number", + "required": false, + "summary": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "The fields to return in the `hits` layer. It supports wildcards (`*`). This parameter does not support fields with array values. Fields with array values may return inconsistent results.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "grid-agg", + "shortName": null, + "type": "string", + "required": false, + "summary": "The aggregation used to create a grid for the `field`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "grid-precision", + "shortName": null, + "type": "number", + "required": false, + "summary": "Additional zoom levels available through the aggs layer. For example, if `` is `7` and `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results don't include the aggs layer.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "grid-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a `geotile_grid` cell. If `grid, each feature is a polygon of the cells bounding box. If `point`, each feature is a Point that is the centroid of the cell.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "The query DSL used to filter documents for the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don't include the hits layer.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort the features in the hits layer. By default, the API calculates a bounding box for each feature. It sorts features based on this box's diagonal length, from longest to shortest.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "track-total-hits", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "The number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-labels", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * `Point` and `MultiPoint` features will have one of the points selected. * `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * `LineString` features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag `_mvt_label_position`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "search-template", + "summary": "Run a search with a search template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`).", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ccs-minimize-roundtrips", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-throttled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies how long a consistent view of the index should be maintained for scrolled search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of the search operation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rest-total-hits-as-int", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, `hits.total` is rendered as an integer in the response. If `false`, it is rendered as an object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "typed-keys", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response prefixes aggregation and suggester names with their respective types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "explain", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, returns detailed information about score calculation as part of each hit. If you specify both this and the `explain` query parameter, the API uses only the query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the search template to use. If no `source` is specified, this parameter is required.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "object", + "required": false, + "summary": "Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "profile", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the query execution is profiled.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "string", + "required": false, + "summary": "An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no `id` is specified, this parameter is required.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "terms-enum", + "summary": "Get terms in an index.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams, indices, and index aliases to search. Wildcard (`*`) expressions are supported. To search all data streams or indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field", + "shortName": null, + "type": "string", + "required": true, + "summary": "The string to match at the start of indexed terms. If not provided, all terms in the field are considered.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of matching terms to return.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The maximum length of time to spend collecting results. If the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-insensitive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When `true`, the provided search string is matched against index terms without case sensitivity.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "Filter an index shard if the provided query rewrites to `match_none`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "string", + "shortName": null, + "type": "string", + "required": false, + "summary": "The string to match at the start of indexed terms. If it is not provided, all terms in the field are considered. > info > The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "string", + "required": false, + "summary": "The string after which terms in the index should be returned. It allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "termvectors", + "summary": "Get term vector information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the index that contains the document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A unique identifier for the document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realtime", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the request is real-time as opposed to near-real-time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "doc", + "shortName": null, + "type": "object", + "required": false, + "summary": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "Filter terms based on their tf-idf scores. This could be useful in order find out a good characteristic vector of a document. This feature works in a similar manner to the second phase of the More Like This Query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-field-analyzer", + "shortName": null, + "type": "object", + "required": false, + "summary": "Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-statistics", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes: * The document count (how many documents contain this field). * The sum of document frequencies (the sum of document frequencies for all terms in this field). * The sum of total term frequencies (the sum of total term frequencies of each term in this field).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "offsets", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes term offsets.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "payloads", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes term payloads.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "positions", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes term positions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "term-statistics", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes: * The total term frequency (how often a term occurs in all documents). * The document frequency (the number of documents containing the current term). By default these values are not returned since term statistics can have a serious performance impact.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value that is used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "If `true`, returns the document version as part of a hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "update", + "summary": "Update a document.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique identifier for the document to be updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the target index. By default, the index is created automatically if it doesn't exist.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "if-primary-term", + "shortName": null, + "type": "number", + "required": false, + "summary": "Only perform the operation if the document has this primary term.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "if-seq-no", + "shortName": null, + "type": "number", + "required": false, + "summary": "Only perform the operation if the document has this sequence number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-source-on-error", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "True or false if to include the document source in the error message in case of parsing errors.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lang", + "shortName": null, + "type": "string", + "required": false, + "summary": "The script language.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "require-alias", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the destination must be an index alias.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "retry-on-conflict", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of times the operation should be retried when a conflict occurs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of copies of each shard that must be active before proceeding with the operation. Set to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1). The default value of `1` means it waits for each primary shard to be active.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "The source fields you want to exclude.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "The source fields you want to retrieve.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "detect-noop", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "doc", + "shortName": null, + "type": "object", + "required": false, + "summary": "A partial update to an existing document. If both `doc` and `script` are specified, `doc` is ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "doc-as-upsert", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, use the contents of 'doc' as the value of 'upsert'. NOTE: Using ingest pipelines with `doc_as_upsert` is not supported.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script", + "shortName": null, + "type": "object", + "required": false, + "summary": "The script to run to update the document.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scripted-upsert", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, run the script whether or not the document exists.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, turn off source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "upsert", + "shortName": null, + "type": "object", + "required": false, + "summary": "If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es" + ], + "name": "update-by-query", + "summary": "Update documents.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzer", + "shortName": null, + "type": "string", + "required": false, + "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyze-wildcard", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "default-operator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "df", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of documents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lenient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pipeline", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "q", + "shortName": null, + "type": "string", + "required": false, + "summary": "A query in the Lucene query string syntax.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes. This is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "request-cache", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request cache is used for this request. It defaults to the index-level setting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "requests-per-second", + "shortName": null, + "type": "number", + "required": false, + "summary": "The throttle for this request in sub-requests per second.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to retain the search context for scrolling.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The size of the scroll request that powers the operation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "An explicit timeout for each search request. By default, there is no timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slices", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of slices this task should be divided into.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "array", + "required": false, + "summary": "A comma-separated list of : pairs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stats", + "shortName": null, + "type": "array", + "required": false, + "summary": "The specific `tag` of the request for logging and statistical purposes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "terminate-after", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. By default, it is one minute. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, returns the document version as part of a hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version-type", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Should the document increment the version number (internal) on hit or not (reindex)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` parameter controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the bulk API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/{taskId}`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-docs", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of documents to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "The documents to update using the Query DSL.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script", + "shortName": null, + "type": "object", + "required": false, + "summary": "The script to run to update the document source or metadata when updating.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slice", + "shortName": null, + "type": "object", + "required": false, + "summary": "Slice the request manually using the provided slice ID and total number of slices.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "conflicts", + "shortName": null, + "type": "string", + "required": false, + "summary": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [ + { + "segment": "async-search", + "summary": "Elasticsearch async-search API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "async-search" + ], + "name": "delete", + "summary": "Delete an async search.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique identifier for the async search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "async-search" + ], + "name": "get", + "summary": "Get async search results.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique identifier for the async search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-alive", + "shortName": null, + "type": "string", + "required": false, + "summary": "The length of time that the async search should be available in the cluster. When not specified, the `keep_alive` set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "typed-keys", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "return-intermediate-results", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout expires or if no wait_for_completion_timeout is specified. If true and the search is still running, the search response will include any hits and partial aggregations that are available. If false and the search is still running, the search response will not include any hits (but possibly include total hits) nor will include any partial aggregations. When not specified, the intermediate results are returned for running queries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "async-search" + ], + "name": "status", + "summary": "Get the async search status.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique identifier for the async search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-alive", + "shortName": null, + "type": "string", + "required": false, + "summary": "The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "async-search" + ], + "name": "submit", + "summary": "Run an async search.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-alive", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-on-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-partial-search-results", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicate if an error should be returned if there is a partial search failure or timeout", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzer", + "shortName": null, + "type": "string", + "required": false, + "summary": "The analyzer to use for the query string", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyze-wildcard", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specify whether wildcard and prefix queries should be analyzed", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batched-reduce-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ccs-minimize-roundtrips", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "The default value is the only supported value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "default-operator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default operator for query string query (AND or OR)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "df", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use as default where no field prefix is given in the query string", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Whether to expand wildcard expression to concrete indices that are open, closed or both", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-throttled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lenient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-concurrent-shard-requests", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preference", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specify the node or shard the operation should be performed on", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "request-cache", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specify if request cache should be used for this request or not, defaults to true", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of specific routing values", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search operation type", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies which field to use for suggestions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest-mode", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specify suggest mode", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "How many suggestions to return in response", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest-text", + "shortName": null, + "type": "string", + "required": false, + "summary": "The source text for which the suggestions should be returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "typed-keys", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rest-total-hits-as-int", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-excludes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A list of fields to exclude from the returned _source field", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-includes", + "shortName": null, + "type": "string", + "required": false, + "summary": "A list of fields to extract and return from the _source field", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "q", + "shortName": null, + "type": "string", + "required": false, + "summary": "Query in the Lucene query string syntax", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggregations", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggs", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "collapse", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "explain", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns detailed information about score computation as part of a hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ext", + "shortName": null, + "type": "object", + "required": false, + "summary": "Configuration of search extensions defined by Elasticsearch plugins.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "highlight", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "track-total-hits", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indices-boost", + "shortName": null, + "type": "array", + "required": false, + "summary": "Boosts the _score of documents from specified indices.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "docvalue-fields", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "knn", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the approximate kNN search to run.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "min-score", + "shortName": null, + "type": "number", + "required": false, + "summary": "Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "post-filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "profile", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the search definition using the Query DSL.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rescore", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script-fields", + "shortName": null, + "type": "object", + "required": false, + "summary": "Retrieve a script evaluation (based on different fields) for each hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slice", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "suggest", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "terminate-after", + "shortName": null, + "type": "number", + "required": false, + "summary": "Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "track-scores", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, calculate and return document scores, even if the scores are not used for sorting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns document version as part of a hit.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "seq-no-primary-term", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stored-fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pit", + "shortName": null, + "type": "object", + "required": false, + "summary": "Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stats", + "shortName": null, + "type": "array", + "required": false, + "summary": "Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "cat", + "summary": "Elasticsearch cat API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "aliases", + "summary": "Get aliases.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to `-1`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "component-templates", + "summary": "Get component templates.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "count", + "summary": "Get a document count.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "help", + "summary": "Get CAT help.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "indices", + "summary": "Get index information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "health", + "shortName": null, + "type": "string", + "required": false, + "summary": "The health status used to limit returned indices. By default, the response includes indices of any health status.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-unloaded-segments", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the response includes information from segments that are not loaded into memory.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pri", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the response only includes information from primary shards.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "ml-data-frame-analytics", + "summary": "Get data frame analytics jobs.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the data frame analytics to fetch", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified.)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of column names to display.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of column names or column aliases used to sort the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "ml-datafeeds", + "summary": "Get datafeeds.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A numerical character string that uniquely identifies the datafeed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of column names to display.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of column names or column aliases used to sort the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "ml-jobs", + "summary": "Get anomaly detection jobs.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the anomaly detection job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of column names to display.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of column names or column aliases used to sort the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "ml-trained-models", + "summary": "Get trained models.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A unique identifier for the trained model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of column names to display.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of column names or aliases used to sort the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of transforms.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of transforms to display.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "transforms", + "summary": "Get transform information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of transforms.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "h", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of column names to display.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "s", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of column names or column aliases used to sort the response.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of transforms to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "cluster", + "summary": "Elasticsearch cluster API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "delete-component-template", + "summary": "Delete component templates.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list or wildcard expression of component template names used to limit the request.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "exists-component-template", + "summary": "Check component templates.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "get-component-template", + "summary": "Get component templates.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Name of component template to retrieve. Wildcard (`*`) expressions are supported.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flat-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, returns settings in flat format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings-filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Return all default configurations for the component template", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "info", + "summary": "Get cluster info.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "target", + "shortName": null, + "type": "string", + "required": true, + "summary": "Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": [ + "_all", + "http", + "ingest", + "thread_pool", + "script" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "put-component-template", + "summary": "Create or update a component template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If 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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "create", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, this request cannot replace or update existing component templates.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cause", + "shortName": null, + "type": "string", + "required": false, + "summary": "User defined reason for create the component template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "template", + "shortName": null, + "type": "object", + "required": true, + "summary": "The template to be applied which includes mappings, settings, or aliases configuration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "Version number used to manage component templates externally. This number isn't automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset `_meta`, replace the template without specifying this information.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "deprecated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "connector", + "summary": "Elasticsearch connector API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "check-in", + "summary": "Check in a connector.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be checked in", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "delete", + "summary": "Delete a connector.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be deleted", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete-sync-jobs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A flag indicating if associated sync jobs should be also removed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "hard", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A flag indicating if the connector should be hard deleted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "get", + "summary": "Get a connector.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-deleted", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "list", + "summary": "Get all connectors.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Starting offset", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies a max number of results to get", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of connector index names to fetch connector documents for", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of connector names to fetch connector documents for", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of connector service types to fetch connector documents for", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-deleted", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "A wildcard query string that filters connectors with matching name, description or index name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "post", + "summary": "Create a connector.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-native", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "language", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "put", + "summary": "Create or update a connector.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-native", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "language", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "sync-job-cancel", + "summary": "Cancel a connector sync job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-sync-job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector sync job", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "sync-job-delete", + "summary": "Delete a connector sync job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-sync-job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector sync job to be deleted", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "sync-job-get", + "summary": "Get a connector sync job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-sync-job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector sync job", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "sync-job-list", + "summary": "Get all connector sync jobs.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Starting offset", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies a max number of results to get", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "status", + "shortName": null, + "type": "string", + "required": false, + "summary": "A sync job status to fetch connector sync jobs for", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A connector id to fetch connector sync jobs for", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of job types to fetch the sync jobs for", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "sync-job-post", + "summary": "Create a connector sync job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id of the associated connector", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "trigger-method", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-active-filtering", + "summary": "Activate the connector draft filter.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-api-key-id", + "summary": "Update the connector API key ID.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "api-key-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "api-key-secret-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-configuration", + "summary": "Update the connector configuration.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "configuration", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "values", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-error", + "summary": "Update the connector error field.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "error", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-filtering", + "summary": "Update the connector filtering.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filtering", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rules", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "advanced-snippet", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-filtering-validation", + "summary": "Update the connector draft filtering validation.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "validation", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-index-name", + "summary": "Update the connector index name.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-name", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-name", + "summary": "Update the connector name and description.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-native", + "summary": "Update the connector is_native flag.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-native", + "shortName": null, + "type": "boolean", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-pipeline", + "summary": "Update the connector pipeline.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pipeline", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-scheduling", + "summary": "Update the connector scheduling.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scheduling", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-service-type", + "summary": "Update the connector service type.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "connector" + ], + "name": "update-status", + "summary": "Update the connector status.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the connector to be updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "status", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "enrich", + "summary": "Elasticsearch enrich API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "enrich" + ], + "name": "delete-policy", + "summary": "Delete an enrich policy.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Enrich policy to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "enrich" + ], + "name": "execute-policy", + "summary": "Run an enrich policy.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Enrich policy to execute.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request blocks other enrich policy execution requests until complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "enrich" + ], + "name": "get-policy", + "summary": "Get an enrich policy.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "enrich" + ], + "name": "put-policy", + "summary": "Create an enrich policy.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Name of the enrich policy to create or update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "geo-match", + "shortName": null, + "type": "object", + "required": false, + "summary": "Matches enrich data to incoming documents based on a `geo_shape` query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "match", + "shortName": null, + "type": "object", + "required": false, + "summary": "Matches enrich data to incoming documents based on a `term` query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "range", + "shortName": null, + "type": "object", + "required": false, + "summary": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "eql", + "summary": "Elasticsearch eql API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "eql" + ], + "name": "delete", + "summary": "Delete an async EQL search.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the search to delete. A search ID is provided in the EQL search API's response for an async search. A search ID is also provided if the request’s `keep_on_completion` parameter is `true`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "eql" + ], + "name": "get", + "summary": "Get async EQL search results.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-alive", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "eql" + ], + "name": "get-status", + "summary": "Get the async EQL status.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "eql" + ], + "name": "search", + "summary": "Get EQL search results.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of index names to scope the operation", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ccs-minimize-roundtrips", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": true, + "summary": "EQL query you wish to run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-sensitive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "event-category-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field containing the event classification, such as process, file, or network.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tiebreaker-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field used to sort hits with the same timestamp in ascending order", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timestamp-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field containing event timestamp.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fetch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Maximum number of events to search at a time for sequence queries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-alive", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-on-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-partial-search-results", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Allow query execution also in case of shard failures. If true, the query will keep running and will return results based on the available shards. For sequences, the behavior can be further refined using allow_partial_sequence_results", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-partial-sequence-results", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "This flag applies only to sequences and has effect only if allow_partial_search_results=true. If true, the sequence query will return results based on the available shards, ignoring the others. If false, the sequence query will return successfully, but will always have empty results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "For basic queries, the maximum number of matching events to return. Defaults to 10", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "object", + "required": false, + "summary": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "result-position", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-samples-per-key", + "shortName": null, + "type": "number", + "required": false, + "summary": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size` parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the `max_samples_per_key` parameter. Pipes are not supported for sample queries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "esql", + "summary": "Elasticsearch esql API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "esql" + ], + "name": "delete-view", + "summary": "Delete an ES|QL view.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The view name to remove.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "esql" + ], + "name": "get-query", + "summary": "Get a specific running ES|QL query information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The query ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "esql" + ], + "name": "get-view", + "summary": "Get an ES|QL view.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The comma-separated view names to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "esql" + ], + "name": "list-queries", + "summary": "Get running ES|QL queries information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "esql" + ], + "name": "put-view", + "summary": "Create or update an ES|QL view.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The view name to create or update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ES|QL query string from which to create a view.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "esql" + ], + "name": "query", + "summary": "Run an ES|QL query.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "format", + "shortName": null, + "type": "string", + "required": false, + "summary": "A short version of the Accept header, e.g. json, yaml. `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delimiter", + "shortName": null, + "type": "string", + "required": false, + "summary": "The character to use between values within a CSV row. Only valid for the CSV format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "drop-null-columns", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results? Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-partial-results", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the query will fail if there are any failures. To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "columnar", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "time-zone", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sets the default timezone of the query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "locale", + "shortName": null, + "type": "string", + "required": false, + "summary": "Returns results (especially dates) formatted per the conventions of the locale.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "array", + "required": false, + "summary": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "profile", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If provided and `true` the response will include an extra `profile` object with information on how the query was executed. This information is for human debugging and its format can change at any time but it can give some insight into the performance of each part of the query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tables", + "shortName": null, + "type": "object", + "required": false, + "summary": "Tables to use with the LOOKUP operation. The top level key is the table name and the next level key is the column name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-ccs-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters` object with information about the clusters that participated in the search along with info such as shards count.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-execution-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When set to `true`, the response will include an extra `_clusters` object with information about the clusters that participated in the search along with info such as shards count. This is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "indices", + "summary": "Elasticsearch indices API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "add-block", + "summary": "Add an index block.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "block", + "shortName": null, + "type": "string", + "required": true, + "summary": "The block type to add to the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "metadata", + "read", + "read_only", + "write" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "analyze", + "summary": "Get tokens from text analysis.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzer", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of the analyzer that should be applied to the provided `text`. This could be a built-in analyzer, or an analyzer that’s been configured in the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attributes", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of token attributes used to filter the output of the `explain` parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "char-filter", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of character filters used to preprocess characters before the tokenizer.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "explain", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes token attributes and additional details.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field used to derive the analyzer. To use this parameter, you must specify an index. If specified, the `analyzer` parameter overrides this value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of token filters used to apply after the tokenizer.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "normalizer", + "shortName": null, + "type": "string", + "required": false, + "summary": "Normalizer to use to convert text into a single token.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "text", + "shortName": null, + "type": "string", + "required": false, + "summary": "Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tokenizer", + "shortName": null, + "type": "string", + "required": false, + "summary": "Tokenizer to use to convert text into tokens.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "cancel-migrate-reindex", + "summary": "Cancel a migration reindex operation.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The index or data stream name", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "create", + "summary": "Create an index.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Name of the index you wish to create. Index names must meet the following criteria: * Lowercase only * Cannot include ``, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` * Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions * Cannot start with `-`, `_`, or `+` * Cannot be `.` or `..` * Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster) * Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aliases", + "shortName": null, + "type": "object", + "required": false, + "summary": "Aliases for the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Mapping for fields in the index. If specified, this mapping can include: - Field names - Field data types - Mapping parameters", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Configuration options for the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "create-data-stream", + "summary": "Create a data stream.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include ``, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; Cannot start with `-`, `_`, `+`, or `.ds-`; Cannot be `.` or `..`; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "create-from", + "summary": "Create an index from a source index.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "string", + "required": true, + "summary": "The source index or data stream name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dest", + "shortName": null, + "type": "string", + "required": true, + "summary": "The destination index or data stream name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "create-from", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "delete", + "summary": "Delete indices.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "delete-alias", + "summary": "Delete an alias.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`).", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of aliases to remove. Supports wildcards (`*`). To remove all aliases, use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "delete-data-stream", + "summary": "Delete data streams.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "delete-index-template", + "summary": "Delete an index template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "exists", + "summary": "Check indices.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`).", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flat-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, returns settings in flat format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, return all default settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request retrieves information from the local node only.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "exists-alias", + "summary": "Check aliases.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of aliases to check. Supports wildcards (`*`).", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "exists-index-template", + "summary": "Check index templates.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flat-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns settings in flat format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "explain-data-lifecycle", + "summary": "Get the status for a data stream lifecycle.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of index names to explain", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if the API should return the default values the system uses for the index's lifecycle", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get", + "summary": "Get index information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flat-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns settings in flat format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, return all default settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "features", + "shortName": null, + "type": "string", + "required": false, + "summary": "Return only information on specified index features", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-alias", + "summary": "Get aliases.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-data-lifecycle", + "summary": "Get data stream lifecycles.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, return all default settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-data-stream", + "summary": "Get data streams.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are returned.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns all relevant default configurations for the index template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "verbose", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether the maximum timestamp for each data stream should be calculated and returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-data-stream-mappings", + "summary": "Get data stream mappings.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`).", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The 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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-data-stream-options", + "summary": "Get data stream options.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-data-stream-settings", + "summary": "Get data stream settings.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`).", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The 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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-index-template", + "summary": "Get index templates.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Name of index template to retrieve. Wildcard (*) expressions are supported.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flat-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns settings in flat format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns all relevant default configurations for the index template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-mapping", + "summary": "Get mapping definitions.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request retrieves information from the local node only.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-migrate-reindex-status", + "summary": "Get the migration reindexing status.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "The index or data stream name.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "get-settings", + "summary": "Get index settings.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list or wildcard expression of settings to retrieve.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flat-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, returns settings in flat format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, return all default settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "migrate-to-data-stream", + "summary": "Convert an index alias to a data stream.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Name of the index alias to convert to a data stream.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "modify-data-stream", + "summary": "Update data streams.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "actions", + "shortName": null, + "type": "array", + "required": true, + "summary": "Actions to perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": "object", + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "put-alias", + "summary": "Create or update an alias.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices return an error.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "Query used to limit documents the alias can access.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. Data stream aliases don’t support this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-write-index", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, sets the write index or data stream for the alias. If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. Data stream aliases don’t support this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "put-data-lifecycle", + "summary": "Update data stream lifecycles.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-retention", + "shortName": null, + "type": "string", + "required": false, + "summary": "If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "downsampling", + "shortName": null, + "type": "array", + "required": false, + "summary": "The downsampling configuration to execute for the managed backing index after rollover.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "downsampling-method", + "shortName": null, + "type": "string", + "required": false, + "summary": "The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires `downsampling` to be defined. Defaults to `aggregate`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle that's disabled (enabled: `false`) will have no effect on the data stream.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "put-data-stream-mappings", + "summary": "Update data stream mappings.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams or data stream patterns.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request does not actually change the mappings on any data streams. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The 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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "mappings", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "put-data-stream-options", + "summary": "Update data stream options.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "failure-store", + "shortName": null, + "type": "object", + "required": false, + "summary": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "put-data-stream-settings", + "summary": "Update data stream settings.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams or data stream patterns.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The 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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "put-index-template", + "summary": "Create or update an index template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Index or template name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "create", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, this request cannot replace or update existing index templates.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cause", + "shortName": null, + "type": "string", + "required": false, + "summary": "User defined reason for creating or updating the index template", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-patterns", + "shortName": null, + "type": "string", + "required": false, + "summary": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "composed-of", + "shortName": null, + "type": "array", + "required": false, + "summary": "An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "template", + "shortName": null, + "type": "object", + "required": false, + "summary": "Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-stream", + "shortName": null, + "type": "object", + "required": false, + "summary": "If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "priority", + "shortName": null, + "type": "number", + "required": false, + "summary": "Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. External systems can use these version numbers to simplify template management. To unset a version, replace the template without specifying one.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional user metadata about the index template. It may have any contents. It is not automatically generated or used by Elasticsearch. This user-defined object is stored in the cluster state, so keeping it short is preferable To unset the metadata, replace the template without specifying it.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-auto-create", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing-component-templates", + "shortName": null, + "type": "array", + "required": false, + "summary": "The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "deprecated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "put-mapping", + "summary": "Update field mappings.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of index names the mapping should be added to (supports wildcards). Use `_all` or omit to add the mapping on all indices.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "write-index-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the mappings are applied only to the current write index for the target.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "date-detection", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Controls whether dynamic date detection is enabled.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dynamic", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Controls whether new fields are added dynamically.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dynamic-date-formats", + "shortName": null, + "type": "array", + "required": false, + "summary": "If date detection is enabled then new string fields are checked against 'dynamic_date_formats' and if the value matches then a new date field is added instead of string.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dynamic-templates", + "shortName": null, + "type": "array", + "required": false, + "summary": "Specify dynamic templates for the mapping.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-names", + "shortName": null, + "type": "object", + "required": false, + "summary": "Control whether field names are enabled for the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "A mapping type can have custom meta data associated with it. These are not used at all by Elasticsearch, but can be used to store application-specific metadata.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "numeric-detection", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Automatically map strings into numeric data types for all fields.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "properties", + "shortName": null, + "type": "object", + "required": false, + "summary": "Mapping for a field. For new fields, this mapping can include: - Field name - Field data type - Mapping parameters", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "object", + "required": false, + "summary": "Enable making a routing value required on indexed documents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "object", + "required": false, + "summary": "Control whether the _source field is enabled on the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime", + "shortName": null, + "type": "object", + "required": false, + "summary": "Mapping of runtime fields for the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "put-settings", + "summary": "Update index settings.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flat-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, returns settings in flat format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preserve-existing", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, existing index settings remain unchanged.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "reopen", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "refresh", + "summary": "Refresh an index.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "remove-block", + "summary": "Remove an index block.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are removing blocks from. To allow the removal of blocks from indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "block", + "shortName": null, + "type": "string", + "required": true, + "summary": "The block type to remove from the index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "metadata", + "read", + "read_only", + "write" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "resolve-index", + "summary": "Resolve indices.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "mode", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "rollover", + "summary": "Roll over to a new index.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "alias", + "shortName": null, + "type": "string", + "required": true, + "summary": "Name of the data stream or index alias to roll over.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "new-index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Name of the index to create. Supports date math. Data streams do not support this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-active-shards", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lazy", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aliases", + "shortName": null, + "type": "object", + "required": false, + "summary": "Aliases for the target index. Data streams do not support this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "conditions", + "shortName": null, + "type": "object", + "required": false, + "summary": "Conditions for the rollover. If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. If this parameter is not specified, Elasticsearch performs the rollover unconditionally. If conditions are specified, at least one of them must be a `max_*` condition. The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping paramaters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Configuration options for the index. Data streams do not support this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "simulate-index-template", + "summary": "Simulate an index.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Name of the index to simulate", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "create", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cause", + "shortName": null, + "type": "string", + "required": false, + "summary": "User defined reason for dry-run creating the new template for simulation purposes", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns all relevant default configurations for the index template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-template", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "simulate-template", + "summary": "Simulate an index template.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "create", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cause", + "shortName": null, + "type": "string", + "required": false, + "summary": "User defined reason for dry-run creating the new template for simulation purposes", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns all relevant default configurations for the index template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-auto-create", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-patterns", + "shortName": null, + "type": "string", + "required": false, + "summary": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "composed-of", + "shortName": null, + "type": "array", + "required": false, + "summary": "An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "template", + "shortName": null, + "type": "object", + "required": false, + "summary": "Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-stream", + "shortName": null, + "type": "object", + "required": false, + "summary": "If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "priority", + "shortName": null, + "type": "number", + "required": false, + "summary": "Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing-component-templates", + "shortName": null, + "type": "array", + "required": false, + "summary": "The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "deprecated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "update-aliases", + "summary": "Create or update an alias.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "actions", + "shortName": null, + "type": "array", + "required": false, + "summary": "Actions to perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "indices" + ], + "name": "validate-query", + "summary": "Validate a query.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "all-shards", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the validation is executed on all shards instead of one random shard per index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzer", + "shortName": null, + "type": "string", + "required": false, + "summary": "Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyze-wildcard", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, wildcard and prefix queries are analyzed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "default-operator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default operator for query string query: `and` or `or`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "df", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "explain", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response returns detailed information if an error has occurred.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lenient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rewrite", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "q", + "shortName": null, + "type": "string", + "required": false, + "summary": "Query in the Lucene query string syntax.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "Query in the Lucene query string syntax.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "inference", + "summary": "Elasticsearch inference API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "chat-completion-unified", + "summary": "Perform chat completion inference on the service.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The inference Id", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference request to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chat-completion-request", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "completion", + "summary": "Perform completion inference on the service.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The inference Id", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference request to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "string", + "required": true, + "summary": "Inference input. Either a string or an array of strings.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "delete", + "summary": "Delete an inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The task type", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The inference identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "embedding", + "summary": "Perform dense embedding inference on the service.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The inference Id", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference request to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "embedding", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "get", + "summary": "Get an inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The task type of the endpoint to return", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The inference Id of the endpoint to return. Using `_all` or `*` will return all endpoints with the specified `task_type` if one is specified, or all endpoints for all task types if no `task_type` is specified", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "inference", + "summary": "Perform inference on the service.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of inference task that the model performs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier for the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The amount of time to wait for the inference request to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "The query input, which is required only for the `rerank` task. It is not required for other tasks.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "string", + "required": true, + "summary": "The text on which you want to perform the inference task. It can be a single string or an array. > info > Inference endpoints for the `completion` task type currently only support a single string as input.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the input data type for the embedding model. The `input_type` parameter only applies to Inference Endpoints with the `embedding` or `text_embedding` task type. Possible values include: * `SEARCH` * `INGEST` * `CLASSIFICATION` * `CLUSTERING` Not all services support all values. Unsupported values will trigger a validation exception. Accepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info. > info > The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put", + "summary": "Create an inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The task type. Refer to the integration list in the API description for the available task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The inference Id", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inference-config", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-ai21", + "summary": "Create a AI21 inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "completion", + "chat_completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ai21-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `ai21`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "ai21" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `ai21` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-alibabacloud", + "summary": "Create an AlibabaCloud AI Search inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "completion", + "rerank", + "sparse_embedding", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alibabacloud-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `sparse_embedding` or `text_embedding` task types. Not applicable to the `rerank` or `completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "alibabacloud-ai-search" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-amazonbedrock", + "summary": "Create an Amazon Bedrock inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "chat_completion", + "completion", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "amazonbedrock-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `chat_completion` and `completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `amazonbedrock`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "amazonbedrock" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `amazonbedrock` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-amazonsagemaker", + "summary": "Create an Amazon SageMaker inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "text_embedding", + "completion", + "chat_completion", + "sparse_embedding", + "rerank" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "amazonsagemaker-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `sparse_embedding` or `text_embedding` task types. Not applicable to the `rerank`, `completion`, or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `amazon_sagemaker`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "amazon_sagemaker" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type and `service_settings.api` you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-anthropic", + "summary": "Create an Anthropic inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The task type. The only valid task type for the model to perform is `completion`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "anthropic-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `anthropic`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "anthropic" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `anthropic` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-azureaistudio", + "summary": "Create an Azure AI studio inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "completion", + "rerank", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "azureaistudio-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank` or `completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `azureaistudio`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "azureaistudio" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `azureaistudio` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-azureopenai", + "summary": "Create an Azure OpenAI inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "completion", + "chat_completion", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "azureopenai-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `completion` and `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `azureopenai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "azureopenai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `azureopenai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-cohere", + "summary": "Create a Cohere inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "completion", + "rerank", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cohere-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank` or `completion` task type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `cohere`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "cohere" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `cohere` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-contextualai", + "summary": "Create an Contextual AI inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "rerank" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "contextualai-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `contextualai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "contextualai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `contextualai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-custom", + "summary": "Create a custom inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "text_embedding", + "sparse_embedding", + "rerank", + "completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "custom-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `sparse_embedding` or `text_embedding` task types. Not applicable to the `rerank` or `completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `custom`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "custom" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `custom` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-deepseek", + "summary": "Create a DeepSeek inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "completion", + "chat_completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "deepseek-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `deepseek`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "deepseek" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `deepseek` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-elasticsearch", + "summary": "Create an Elasticsearch inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "rerank", + "sparse_embedding", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "elasticsearch-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint. The must not match the `model_id`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `sparse_embedding` and `text_embedding` task types. Not applicable to the `rerank` task type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `elasticsearch`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "elasticsearch" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `elasticsearch` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-elser", + "summary": "Create an ELSER inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "sparse_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "elser-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Note that for ELSER endpoints, the max_chunk_size may not exceed `300`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `elser`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "elser" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `elser` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-fireworksai", + "summary": "Create a Fireworks AI inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "chat_completion", + "completion", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fireworksai-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `completion` or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `fireworksai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "fireworksai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `fireworksai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. Applies only to the `completion` or `chat_completion` task types. Not applicable to the `text_embedding` task type. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-googleaistudio", + "summary": "Create an Google AI Studio inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "completion", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "googleaistudio-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `completion` task type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `googleaistudio`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "googleaistudio" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-googlevertexai", + "summary": "Create a Google Vertex AI inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "rerank", + "text_embedding", + "completion", + "chat_completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "googlevertexai-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank`, `completion`, or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `googlevertexai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "googlevertexai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `googlevertexai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-groq", + "summary": "Create a Groq inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "chat_completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "groq-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `groq`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "groq" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `groq` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-hugging-face", + "summary": "Create a Hugging Face inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "chat_completion", + "completion", + "rerank", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "huggingface-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank`, `completion`, or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `hugging_face`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "hugging_face" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-jinaai", + "summary": "Create an JinaAI inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "embedding", + "rerank", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "jinaai-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `embedding` and text_embedding` task types. Not applicable to the `rerank` task type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `jinaai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "jinaai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `jinaai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-llama", + "summary": "Create a Llama inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "text_embedding", + "completion", + "chat_completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "llama-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `completion` or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `llama`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "llama" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `llama` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-mistral", + "summary": "Create a Mistral inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "text_embedding", + "completion", + "chat_completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "mistral-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `completion` or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `mistral`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "mistral" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `mistral` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-nvidia", + "summary": "Create an Nvidia inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "chat_completion", + "completion", + "rerank", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "nvidia-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank`, `completion`, or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `nvidia`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "nvidia" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `nvidia` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. Applies only to the `text_embedding` task type. Not applicable to the `rerank`, `completion`, or `chat_completion` task types. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-openai", + "summary": "Create an OpenAI inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "chat_completion", + "completion", + "text_embedding" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "openai-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `completion` or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `openai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "openai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `openai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-openshift-ai", + "summary": "Create an OpenShift AI inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "text_embedding", + "completion", + "chat_completion", + "rerank" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "openshiftai-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank`, `completion`, or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `openshift_ai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "openshift_ai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `openshift_ai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. Applies only to the `rerank` task type. Not applicable to the `text_embedding`, `completion`, or `chat_completion` task types. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-voyageai", + "summary": "Create a VoyageAI inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "text_embedding", + "rerank" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "voyageai-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank` task type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `voyageai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "voyageai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `voyageai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings to configure the inference task. These settings are specific to the task type you specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "put-watsonx", + "summary": "Create a Watsonx inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the inference task that the model will perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "text_embedding", + "rerank", + "chat_completion", + "completion" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "watsonx-inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference endpoint to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank`, `completion` or `chat_completion` task types.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of service supported for the specified task type. In this case, `watsonxai`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "watsonxai" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service-settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Settings used to install the inference model. These settings are specific to the `watsonxai` service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "rerank", + "summary": "Perform reranking inference on the service.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier for the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The amount of time to wait for the inference request to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": true, + "summary": "Query input.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "array", + "required": true, + "summary": "The documents to rank.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": "string", + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "return-documents", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Include the document text in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "top-n", + "shortName": null, + "type": "number", + "required": false, + "summary": "Limit the response to the top N documents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "sparse-embedding", + "summary": "Perform sparse embedding inference on the service.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The inference Id", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference request to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "string", + "required": true, + "summary": "Inference input. Either a string or an array of strings.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "stream-completion", + "summary": "Perform streaming completion inference on the service.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier for the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The amount of time to wait for the inference request to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "string", + "required": true, + "summary": "The text on which you want to perform the inference task. It can be a single string or an array. NOTE: Inference endpoints for the completion task type currently only support a single string as input.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "text-embedding", + "summary": "Perform text embedding inference on the service.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The inference Id", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the inference request to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "string", + "required": true, + "summary": "Inference input. Either a string or an array of strings.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The input data type for the text embedding model. Possible values include: * `SEARCH` * `INGEST` * `CLASSIFICATION` * `CLUSTERING` Not all services support all values. Unsupported values will trigger a validation exception. Accepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info. > info > The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "inference" + ], + "name": "update", + "summary": "Update an inference endpoint.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inference-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the inference endpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "task-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of inference task that the model performs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inference-config", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "ingest", + "summary": "Elasticsearch ingest API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "ingest" + ], + "name": "delete-pipeline", + "summary": "Delete pipelines.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ingest" + ], + "name": "get-pipeline", + "summary": "Get pipelines.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "summary", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Return pipelines without their definitions", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ingest" + ], + "name": "processor-grok", + "summary": "Run a grok processor.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ingest" + ], + "name": "put-pipeline", + "summary": "Create or update a pipeline.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "ID of the ingest pipeline to create or update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "master-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "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.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "if-version", + "shortName": null, + "type": "number", + "required": false, + "summary": "Required version for optimistic concurrency control for pipeline updates", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Description of the ingest pipeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "on-failure", + "shortName": null, + "type": "array", + "required": false, + "summary": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "processors", + "shortName": null, + "type": "array", + "required": false, + "summary": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "number", + "required": false, + "summary": "Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "deprecated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-access-pattern", + "shortName": null, + "type": "string", + "required": false, + "summary": "Controls how processors in this pipeline should read and write data on a document's source.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ingest" + ], + "name": "simulate", + "summary": "Simulate a pipeline.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "verbose", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes output data for each processor in the executed pipeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "docs", + "shortName": null, + "type": "array", + "required": true, + "summary": "Sample documents to test in the pipeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": "object", + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pipeline", + "shortName": null, + "type": "object", + "required": false, + "summary": "The pipeline to test. If you don't specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "license", + "summary": "Elasticsearch license API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "license" + ], + "name": "get", + "summary": "Get license information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "accept-enterprise", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. This parameter is deprecated and will always be set to true in 8.x.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "local", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether to retrieve local information. From 9.2 onwards the default value is `true`, which means the information is retrieved from the responding node. In earlier versions the default is `false`, which means the information is retrieved from the elected master node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "logstash", + "summary": "Elasticsearch logstash API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "logstash" + ], + "name": "delete-pipeline", + "summary": "Delete a Logstash pipeline.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the pipeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "logstash" + ], + "name": "get-pipeline", + "summary": "Get Logstash pipelines.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of pipeline identifiers.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "logstash" + ], + "name": "put-pipeline", + "summary": "Create or update a Logstash pipeline.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the pipeline. Pipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pipeline", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "ml", + "summary": "Elasticsearch ml API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "close-job", + "summary": "Close anomaly detection jobs.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Refer to the description for the `allow_no_match` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Refer to the descriptiion for the `force` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `timeout` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-calendar", + "summary": "Delete a calendar.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "calendar-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a calendar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-calendar-event", + "summary": "Delete events from a calendar.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "calendar-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a calendar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "event-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the scheduled event. You can obtain this identifier by using the get calendar events API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-calendar-job", + "summary": "Delete anomaly jobs from a calendar.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "calendar-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a calendar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-data-frame-analytics", + "summary": "Delete a data frame analytics job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the data frame analytics job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The time to wait for the job to be deleted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-datafeed", + "summary": "Delete a datafeed.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Use to forcefully delete a started datafeed; this method is quicker than stopping and deleting the datafeed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-filter", + "summary": "Delete a filter.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "filter-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a filter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-job", + "summary": "Delete an anomaly detection job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the anomaly detection job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Use to forcefully delete an opened job; this method is quicker than closing and deleting the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete-user-annotations", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether the request should return immediately or wait until the job deletion completes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-trained-model", + "summary": "Delete an unreferenced trained model.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the trained model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "delete-trained-model-alias", + "summary": "Delete a trained model alias.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-alias", + "shortName": null, + "type": "string", + "required": true, + "summary": "The model alias to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The trained model ID to which the model alias refers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "estimate-model-memory", + "summary": "Estimate job model memory usage.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "analysis-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "For a list of the properties that you can specify in the `analysis_config` component of the body of this API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-bucket-cardinality", + "shortName": null, + "type": "object", + "required": false, + "summary": "Estimates of the highest cardinality in a single bucket that is observed for influencer fields over the time period that the job analyzes data. To produce a good answer, values must be provided for all influencer fields. Providing values for fields that are not listed as `influencers` has no effect on the estimation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "overall-cardinality", + "shortName": null, + "type": "object", + "required": false, + "summary": "Estimates of the cardinality that is observed for fields over the whole time period that the job analyzes data. To produce a good answer, values must be provided for fields referenced in the `by_field_name`, `over_field_name` and `partition_field_name` of any detectors. Providing values for other fields has no effect on the estimation. It can be omitted from the request if no detectors have a `by_field_name`, `over_field_name` or `partition_field_name`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "evaluate-data-frame", + "summary": "Evaluate data frame analytics.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "evaluation", + "shortName": null, + "type": "object", + "required": true, + "summary": "Defines the type of evaluation you want to perform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Defines the `index` in which the evaluation will be performed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "A query clause that retrieves a subset of data from the source index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "flush-job", + "summary": "Force buffered data to be processed.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the anomaly detection job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "advance-time", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `advance_time` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "calc-interim", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Refer to the description for the `calc_interim` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `end` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-time", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `skip_time` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `start` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-calendar-events", + "summary": "Get info about events in calendars.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "calendar-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies to get events with timestamps earlier than this time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of events.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of events to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies to get events with timestamps after this time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-calendars", + "summary": "Get calendar configuration info.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "calendar-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "object", + "required": false, + "summary": "This object is supported only when you omit the calendar identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-data-frame-analytics", + "summary": "Get data frame analytics job configuration info.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of data frame analytics jobs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of data frame analytics jobs to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-generated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-data-frame-analytics-stats", + "summary": "Get data frame analytics job stats.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of data frame analytics jobs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of data frame analytics jobs to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "verbose", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Defines whether the stats response should be verbose.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-datafeed-stats", + "summary": "Get datafeed stats.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-datafeeds", + "summary": "Get datafeeds configuration info.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-generated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-filters", + "summary": "Get filters.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "filter-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A string that uniquely identifies a filter.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of filters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of filters to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-job-stats", + "summary": "Get anomaly detection job stats.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a `404` status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-jobs", + "summary": "Get anomaly detection jobs configuration info.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-generated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-overall-buckets", + "summary": "Get overall bucket results.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. You can summarize the bucket results for all anomaly detection jobs by using `_all` or by specifying `*` as the ``.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Refer to the description for the `allow_no_match` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "bucket-span", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `bucket_span` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `end` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-interim", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Refer to the description for the `exclude_interim` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "overall-score", + "shortName": null, + "type": "number", + "required": false, + "summary": "Refer to the description for the `overall_score` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `start` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "top-n", + "shortName": null, + "type": "number", + "required": false, + "summary": "Refer to the description for the `top_n` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-trained-models", + "summary": "Get trained model configuration info.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: - Contains wildcard expressions and there are no models that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. If true, it returns an empty array when there are no matches and the subset of results when there are partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "decompress-definition", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-generated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of models.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma delimited string of optional fields to include in the response body.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of models to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "get-trained-models-stats", + "summary": "Get trained models usage info.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: - Contains wildcard expressions and there are no models that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. If true, it returns an empty array when there are no matches and the subset of results when there are partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of models.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of models to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "infer-trained-model", + "summary": "Evaluate a trained model.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the trained model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Controls the amount of time to wait for inference results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "docs", + "shortName": null, + "type": "array", + "required": true, + "summary": "An array of objects to pass to the model for inference. The objects should contain a fields matching your configured trained model input. Typically, for NLP models, the field name is `text_field`. Currently, for NLP models, only a single value is allowed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": "object", + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inference-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "The inference configuration updates to apply on the API call", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "open-job", + "summary": "Open anomaly detection jobs.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the anomaly detection job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `timeout` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "post-calendar-events", + "summary": "Add scheduled events to the calendar.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "calendar-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a calendar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "events", + "shortName": null, + "type": "array", + "required": true, + "summary": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": "object", + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "preview-data-frame-analytics", + "summary": "Preview features used by data frame analytics.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the data frame analytics job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config", + "shortName": null, + "type": "object", + "required": false, + "summary": "A data frame analytics config as described in create data frame analytics jobs. Note that `id` and `dest` don’t need to be provided in the context of this API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "preview-datafeed", + "summary": "Preview a datafeed.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job configuration details in the request body.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "The start time from where the datafeed preview should begin", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "The end time when the datafeed preview should stop", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "datafeed-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "The datafeed definition to preview.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "The configuration details for the anomaly detection job that is associated with the datafeed. If the `datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must supply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is used. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-calendar", + "summary": "Create a calendar.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "calendar-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a calendar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of anomaly detection job identifiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description of the calendar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-calendar-job", + "summary": "Add anomaly detection job to calendar.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "calendar-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a calendar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-data-frame-analytics", + "summary": "Create a data frame analytics job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-lazy-start", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. If set to `false` and a machine learning node with capacity to run the job cannot be immediately found, the API returns an error. If set to `true`, the API does not return an error; the job waits in the `starting` state until sufficient machine learning node capacity is available. This behavior is also affected by the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analysis", + "shortName": null, + "type": "object", + "required": true, + "summary": "The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analyzed-fields", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies `includes` and/or `excludes` patterns to select which fields will be included in the analysis. The patterns specified in `excludes` are applied last, therefore `excludes` takes precedence. In other words, if the same field is specified in both `includes` and `excludes`, then the field will not be included in the analysis. If `analyzed_fields` is not set, only the relevant fields will be included. For example, all the numeric fields for outlier detection. The supported fields vary for each type of analysis. Outlier detection requires numeric or `boolean` data to analyze. The algorithms don’t support missing values therefore fields that have data types other than numeric or boolean are ignored. Documents where included fields contain missing values, null values, or an array are also ignored. Therefore the `dest` index may contain documents that don’t have an outlier score. Regression supports fields that are numeric, `boolean`, `text`, `keyword`, and `ip` data types. It is also tolerant of missing values. Fields that are supported are included in the analysis, other fields are ignored. Documents where included fields contain an array with two or more values are also ignored. Documents in the `dest` index that don’t contain a results field are not included in the regression analysis. Classification supports fields that are numeric, `boolean`, `text`, `keyword`, and `ip` data types. It is also tolerant of missing values. Fields that are supported are included in the analysis, other fields are ignored. Documents where included fields contain an array with two or more values are also ignored. Documents in the `dest` index that don’t contain a results field are not included in the classification analysis. Classification analysis can be improved by mapping ordinal variable values to a single number. For example, in case of age ranges, you can model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description of the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dest", + "shortName": null, + "type": "object", + "required": true, + "summary": "The destination configuration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-num-threads", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-memory-limit", + "shortName": null, + "type": "string", + "required": false, + "summary": "The approximate maximum amount of memory resources that are permitted for analytical processing. If your `elasticsearch.yml` file contains an `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create data frame analytics jobs that have `model_memory_limit` values greater than that setting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "object", + "required": true, + "summary": "The configuration of how to source the analysis data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "headers", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-datafeed", + "summary": "Create a datafeed.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-throttled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, concrete, expanded, or aliased indices are ignored when frozen.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggregations", + "shortName": null, + "type": "object", + "required": false, + "summary": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggs", + "shortName": null, + "type": "object", + "required": false, + "summary": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated; it is an advanced configuration option.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delayed-data-check-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "frequency", + "shortName": null, + "type": "string", + "required": false, + "summary": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indices", + "shortName": null, + "type": "string", + "required": false, + "summary": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master nodes and the machine learning nodes must have the `remote_cluster_client` role.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indexes", + "shortName": null, + "type": "string", + "required": false, + "summary": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master nodes and the machine learning nodes must have the `remote_cluster_client` role.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indices-options", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies index expansion options that are used during search", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the anomaly detection job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-empty-searches", + "shortName": null, + "type": "number", + "required": false, + "summary": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically stops and closes the associated job after this many real-time searches return no documents. In other words, it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no end time that sees no data remains started until it is explicitly stopped. By default, it is not set.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query-delay", + "shortName": null, + "type": "string", + "required": false, + "summary": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies runtime fields for the datafeed search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script-fields", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "headers", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-filter", + "summary": "Create a filter.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "filter-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a filter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description of the filter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "items", + "shortName": null, + "type": "array", + "required": false, + "summary": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-job", + "summary": "Create an anomaly detection job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-throttled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-lazy-open", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analysis-config", + "shortName": null, + "type": "object", + "required": true, + "summary": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analysis-limits", + "shortName": null, + "type": "object", + "required": false, + "summary": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "background-persist-interval", + "shortName": null, + "type": "string", + "required": false, + "summary": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "custom-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Advanced configuration option. Contains custom meta data about the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "daily-model-snapshot-retention-after-days", + "shortName": null, + "type": "number", + "required": false, + "summary": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-description", + "shortName": null, + "type": "object", + "required": true, + "summary": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "datafeed-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description of the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "groups", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of job groups. A job can belong to no groups or many.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-plot-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-snapshot-retention-days", + "shortName": null, + "type": "number", + "required": false, + "summary": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "renormalization-window-days", + "shortName": null, + "type": "number", + "required": false, + "summary": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "results-index-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "results-retention-days", + "shortName": null, + "type": "number", + "required": false, + "summary": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-trained-model", + "summary": "Create a trained model.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the trained model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "defer-definition-decompression", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to wait for all child operations (e.g. model download) to complete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "compressed-definition", + "shortName": null, + "type": "string", + "required": false, + "summary": "The compressed (GZipped and Base64 encoded) inference definition of the model. If compressed_definition is specified, then definition cannot be specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "definition", + "shortName": null, + "type": "object", + "required": false, + "summary": "The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A human-readable description of the inference trained model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inference-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "object", + "required": false, + "summary": "The input field names for the model definition.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "An object map that contains metadata about the model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The model type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-size-bytes", + "shortName": null, + "type": "number", + "required": false, + "summary": "The estimated memory usage in bytes to keep the trained model in memory. This property is supported only if defer_definition_decompression is true or the model definition is not supplied.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "platform-architecture", + "shortName": null, + "type": "string", + "required": false, + "summary": "The platform architecture (if applicable) of the trained mode. If the model only works on one platform, because it is heavily optimized for a particular processor architecture and OS combination, then this field specifies which. The format of the string must match the platform identifiers used by Elasticsearch, so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`, or `windows-x86_64`. For portable models (those that work independent of processor architecture or OS features), leave this field unset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of tags to organize the model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prefix-strings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional prefix strings applied at inference", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-trained-model-alias", + "summary": "Create or update a trained model alias.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-alias", + "shortName": null, + "type": "string", + "required": true, + "summary": "The alias to create or update. This value cannot end in numbers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the trained model that the alias refers to.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "reassign", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model. If the alias is already assigned and this parameter is false, the API returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-trained-model-definition-part", + "summary": "Create part of a trained model definition.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the trained model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "part", + "shortName": null, + "type": "number", + "required": true, + "summary": "The definition part number. When the definition is loaded for inference the definition parts are streamed in the order of their part number. The first part must be `0` and the final part must be `total_parts - 1`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "definition", + "shortName": null, + "type": "string", + "required": true, + "summary": "The definition part for the model. Must be a base64 encoded string.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "total-definition-length", + "shortName": null, + "type": "number", + "required": true, + "summary": "The total uncompressed definition length in bytes. Not base64 encoded.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "total-parts", + "shortName": null, + "type": "number", + "required": true, + "summary": "The total number of parts that will be uploaded. Must be greater than 0.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "put-trained-model-vocabulary", + "summary": "Create a trained model vocabulary.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the trained model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "vocabulary", + "shortName": null, + "type": "array", + "required": true, + "summary": "The model vocabulary, which must not be empty.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": "string", + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "merges", + "shortName": null, + "type": "array", + "required": false, + "summary": "The optional model merges if required by the tokenizer.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scores", + "shortName": null, + "type": "array", + "required": false, + "summary": "The optional vocabulary value scores if required by the tokenizer.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "reset-job", + "summary": "Reset an anomaly detection job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the job to reset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Should this request wait until the operation has completed before returning.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete-user-annotations", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "start-data-frame-analytics", + "summary": "Start a data frame analytics job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Controls the amount of time to wait until the data frame analytics job starts.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "start-datafeed", + "summary": "Start datafeeds.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `end` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `start` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `timeout` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "start-trained-model-deployment", + "summary": "Start a trained model deployment.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cache-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The inference cache size (in memory outside the JVM heap) per node for the model. The default value is the same size as the `model_size_bytes`. To disable the cache, `0b` can be provided.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A unique identifier for the deployment of the model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "number-of-allocations", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. If adaptive_allocations is enabled, do not set this value, because it’s automatically set.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "priority", + "shortName": null, + "type": "string", + "required": false, + "summary": "The deployment priority", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "queue-capacity", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds this value, new requests are rejected with a 429 error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "threads-per-allocation", + "shortName": null, + "type": "number", + "required": false, + "summary": "Sets the number of threads used by each model allocation during inference. This generally increases the inference speed. The inference process is a compute-bound process; any number greater than the number of available hardware threads on the machine does not increase the inference speed. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the amount of time to wait for the model to deploy.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies the allocation status to wait for before returning.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "adaptive-allocations", + "shortName": null, + "type": "object", + "required": false, + "summary": "Adaptive allocations configuration. When enabled, the number of allocations is set based on the current load. If adaptive_allocations is enabled, do not set the number of allocations manually.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "stop-data-frame-analytics", + "summary": "Stop data frame analytics jobs.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is true, which returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the data frame analytics job is stopped forcefully.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "stop-datafeed", + "summary": "Stop datafeeds.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as the identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Refer to the description for the `allow_no_match` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Refer to the description for the `force` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Refer to the description for the `timeout` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "close-job", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Refer to the description for the `close_job` query parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "stop-trained-model-deployment", + "summary": "Stop a trained model deployment.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the trained model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "If provided, must be the same identifier as in the path.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you restart the model deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "update-data-frame-analytics", + "summary": "Update a data frame analytics job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description of the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-memory-limit", + "shortName": null, + "type": "string", + "required": false, + "summary": "The approximate maximum amount of memory resources that are permitted for analytical processing. If your `elasticsearch.yml` file contains an `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create data frame analytics jobs that have `model_memory_limit` values greater than that setting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-num-threads", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-lazy-start", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "update-datafeed", + "summary": "Update a datafeed.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datafeed-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-indices", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expand-wildcards", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-throttled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unavailable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggregations", + "shortName": null, + "type": "object", + "required": false, + "summary": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "chunking-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "Datafeeds might search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated; it is an advanced configuration option.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delayed-data-check-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "frequency", + "shortName": null, + "type": "string", + "required": false, + "summary": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indices", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indexes", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": "string", + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indices-options", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies index expansion options that are used during search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-empty-searches", + "shortName": null, + "type": "number", + "required": false, + "summary": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically stops and closes the associated job after this many real-time searches return no documents. In other words, it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no end time that sees no data remains started until it is explicitly stopped. By default, it is not set.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also changed. Therefore, the time required to learn might be long and the understandability of the results is unpredictable. If you want to make significant changes to the source data, it is recommended that you clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one when you are satisfied with the results of the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query-delay", + "shortName": null, + "type": "string", + "required": false, + "summary": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies runtime fields for the datafeed search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "script-fields", + "shortName": null, + "type": "object", + "required": false, + "summary": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "update-filter", + "summary": "Update a filter.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "filter-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that uniquely identifies a filter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "add-items", + "shortName": null, + "type": "array", + "required": false, + "summary": "The items to add to the filter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description for the filter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "remove-items", + "shortName": null, + "type": "array", + "required": false, + "summary": "The items to remove from the filter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "update-job", + "summary": "Update an anomaly detection job.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "job-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-lazy-open", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. If `false` and a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to `true`, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "analysis-limits", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "background-persist-interval", + "shortName": null, + "type": "string", + "required": false, + "summary": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low. If the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "custom-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information as shown in Adding custom URLs to machine learning results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "categorization-filters", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description of the job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-plot-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-prune-window", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "daily-model-snapshot-retention-after-days", + "shortName": null, + "type": "number", + "required": false, + "summary": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. For jobs created before version 7.8.0, the default value matches `model_snapshot_retention_days`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-snapshot-retention-days", + "shortName": null, + "type": "number", + "required": false, + "summary": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "renormalization-window-days", + "shortName": null, + "type": "number", + "required": false, + "summary": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "results-retention-days", + "shortName": null, + "type": "number", + "required": false, + "summary": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "groups", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of job groups. A job can belong to no groups or many.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "detectors", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of detector update objects.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-partition-categorization", + "shortName": null, + "type": "object", + "required": false, + "summary": "Settings related to how categorization interacts with partition fields.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "ml" + ], + "name": "update-trained-model-deployment", + "summary": "Update a trained model deployment.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "number-of-allocations", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. If adaptive_allocations is enabled, do not set this value, because it’s automatically set.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "adaptive-allocations", + "shortName": null, + "type": "object", + "required": false, + "summary": "Adaptive allocations configuration. When enabled, the number of allocations is set based on the current load. If adaptive_allocations is enabled, do not set the number of allocations manually.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "project", + "summary": "Elasticsearch project API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "project" + ], + "name": "create-many-routing", + "summary": "Create or update project routing expressions.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "expressions", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "project" + ], + "name": "create-routing", + "summary": "Create or update a project routing expression.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of project routing expression", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expressions", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "project" + ], + "name": "delete-routing", + "summary": "Delete a project routing expression.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of project routing expression", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "project" + ], + "name": "get-many-routing", + "summary": "Get project routing expressions.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "project" + ], + "name": "get-routing", + "summary": "Get a project routing expression.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of project routing expression", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "project" + ], + "name": "tags", + "summary": "Get tags.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "query-rules", + "summary": "Elasticsearch query-rules API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "query-rules" + ], + "name": "delete-rule", + "summary": "Delete a query rule.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query ruleset containing the rule to delete", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query rule within the specified ruleset to delete", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "query-rules" + ], + "name": "delete-ruleset", + "summary": "Delete a query ruleset.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query ruleset to delete", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "query-rules" + ], + "name": "get-rule", + "summary": "Get a query rule.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query ruleset containing the rule to retrieve", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query rule within the specified ruleset to retrieve", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "query-rules" + ], + "name": "get-ruleset", + "summary": "Get a query ruleset.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query ruleset", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "query-rules" + ], + "name": "list-rulesets", + "summary": "Get all query rulesets.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "The offset from the first result to fetch.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of results to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "query-rules" + ], + "name": "put-rule", + "summary": "Create or update a query rule.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query ruleset containing the rule to be created or updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query rule within the specified ruleset to be created or updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": [ + "pinned", + "exclude" + ], + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "criteria", + "shortName": null, + "type": "object", + "required": true, + "summary": "The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "actions", + "shortName": null, + "type": "object", + "required": true, + "summary": "The actions to take when the rule is matched. The format of this action depends on the rule type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "priority", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "query-rules" + ], + "name": "put-ruleset", + "summary": "Create or update a query ruleset.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query ruleset to be created or updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rules", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "query-rules" + ], + "name": "test", + "summary": "Test a query ruleset.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the query ruleset to be created or updated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "match-criteria", + "shortName": null, + "type": "object", + "required": true, + "summary": "The match criteria to apply to rules in the given query ruleset. Match criteria should match the keys defined in the `criteria.metadata` field of the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "search-application", + "summary": "Elasticsearch search-application API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "search-application" + ], + "name": "delete", + "summary": "Delete a search application.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the search application to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "search-application" + ], + "name": "delete-behavioral-analytics", + "summary": "Delete a behavioral analytics collection.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the analytics collection to be deleted", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "search-application" + ], + "name": "get", + "summary": "Get search application details.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the search application", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "search-application" + ], + "name": "get-behavioral-analytics", + "summary": "Get behavioral analytics collections.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of analytics collections to limit the returned information", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "search-application" + ], + "name": "list", + "summary": "Get search applications.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "q", + "shortName": null, + "type": "string", + "required": false, + "summary": "Query in the Lucene query string syntax.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Starting offset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies a max number of results to get.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "search-application" + ], + "name": "put", + "summary": "Create or update a search application.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the search application to be created or updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "create", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, this request cannot replace or update existing Search Applications.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-application", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "search-application" + ], + "name": "put-behavioral-analytics", + "summary": "Create a behavioral analytics collection.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the analytics collection to be created or updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "search-application" + ], + "name": "search", + "summary": "Run a search application search.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the search application to be searched.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "typed-keys", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether aggregation names are prefixed by their respective types in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "object", + "required": false, + "summary": "Query parameters specific to this request, which will override any defaults specified in the template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security", + "summary": "Elasticsearch security API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "security" + ], + "name": "authenticate", + "summary": "Authenticate a user.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "create-api-key", + "summary": "Create an API key.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expiration", + "shortName": null, + "type": "string", + "required": false, + "summary": "The expiration time for the API key. By default, API keys never expire.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "A name for the API key.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "role-descriptors", + "shortName": null, + "type": "object", + "required": false, + "summary": "An array of role descriptors for this API key. When it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for the create role API. For more details, refer to the create or update roles API. NOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges. In this case, you must explicitly specify a role descriptor with no privileges. The derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "delete-role", + "summary": "Delete roles.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the role.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "get-api-key", + "summary": "Get API key information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "An API key id. This parameter cannot be used with any of `name`, `realm_name` or `username`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "An API key name. This parameter cannot be used with any of `id`, `realm_name` or `username`. It supports prefix search with wildcard.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "owner", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A boolean flag that can be used to query API keys owned by the currently authenticated user. The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realm-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of an authentication realm. This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "username", + "shortName": null, + "type": "string", + "required": false, + "summary": "The username of a user. This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-limited-by", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "active-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-profile-uid", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "get-builtin-privileges", + "summary": "Get builtin privileges.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "get-role", + "summary": "Get roles.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about all roles.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "has-privileges", + "summary": "Check user privileges.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "user", + "shortName": null, + "type": "string", + "required": false, + "summary": "Username", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "application", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cluster", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of the cluster privileges that you want to check.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "invalidate-api-key", + "summary": "Invalidate API keys.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of API key ids. This parameter cannot be used with any of `name`, `realm_name`, or `username`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "An API key name. This parameter cannot be used with any of `ids`, `realm_name` or `username`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "owner", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Query API keys owned by the currently authenticated user. The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. NOTE: At least one of `ids`, `name`, `username`, and `realm_name` must be specified if `owner` is `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "realm-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of an authentication realm. This parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "username", + "shortName": null, + "type": "string", + "required": false, + "summary": "The username of a user. This parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "put-role", + "summary": "Create or update roles.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "applications", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of application privilege entries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cluster", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of cluster privileges. These privileges define the cluster-level actions for users with this role.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "global", + "shortName": null, + "type": "object", + "required": false, + "summary": "An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indices", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of indices permissions entries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "remote-indices", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of remote indices permissions entries. NOTE: Remote indices are effective for remote clusters configured with the API key based model. They have no effect for remote clusters configured with the certificate based model.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "remote-cluster", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of remote cluster permissions entries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "run-as", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional description of the role descriptor", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "transient-metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "query-api-keys", + "summary": "Find API keys with a query.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "with-limited-by", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it). An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-profile-uid", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether to also retrieve the profile UID for the API key owner principal. If it exists, the profile UID is returned under the `profile_uid` response field for each API key.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "typed-keys", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether aggregation names are prefixed by their respective types in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggregations", + "shortName": null, + "type": "object", + "required": false, + "summary": "Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only on the API keys that match the query. This supports only a subset of aggregation types, namely: `terms`, `range`, `date_range`, `missing`, `cardinality`, `value_count`, `composite`, `filter`, and `filters`. Additionally, aggregations only run over the same subset of fields that query works with.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggs", + "shortName": null, + "type": "object", + "required": false, + "summary": "Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only on the API keys that match the query. This supports only a subset of aggregation types, namely: `terms`, `range`, `date_range`, `missing`, `cardinality`, `value_count`, `composite`, `filter`, and `filters`. Additionally, aggregations only run over the same subset of fields that query works with.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "A query to filter which API keys to return. If the query parameter is missing, it is equivalent to a `match_all` query. The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`, `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`. You can query the following public information associated with an API key: `id`, `type`, `name`, `creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`. NOTE: The queryable string values associated with API keys are internally mapped as keywords. Consequently, if no `analyzer` parameter is specified for a `match` query, then the provided match query string is interpreted as a single keyword value. Such a match query is hence equivalent to a `term` query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "The sort definition. Other than `id`, all public fields of an API key are eligible for sorting. In addition, sort can also be applied to the `_doc` field to sort by index order.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of hits to return. It must not be negative. The `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "array", + "required": false, + "summary": "The search after definition.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "query-role", + "summary": "Find roles with a query.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "A query to filter which roles to return. If the query parameter is missing, it is equivalent to a `match_all` query. The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`, `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`. You can query the following information associated with roles: `name`, `description`, `metadata`, `applications.application`, `applications.privileges`, and `applications.resources`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "The sort definition. You can sort on `name`, `description`, `metadata`, `applications.application`, `applications.privileges`, and `applications.resources`. In addition, sort can also be applied to the `_doc` field to sort by index order.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of hits to return. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "array", + "required": false, + "summary": "The search after definition.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "security" + ], + "name": "update-api-key", + "summary": "Update an API key.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the API key to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "role-descriptors", + "shortName": null, + "type": "object", + "required": false, + "summary": "The role descriptors to assign to this API key. The API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not. The structure of a role descriptor is the same as the request for the create API keys API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "Arbitrary metadata that you want to associate with the API key. It supports a nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. When specified, this value fully replaces the metadata previously associated with the API key.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "expiration", + "shortName": null, + "type": "string", + "required": false, + "summary": "The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the expiration unchanged.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "sql", + "summary": "Elasticsearch sql API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "sql" + ], + "name": "clear-cursor", + "summary": "Clear an SQL search cursor.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "cursor", + "shortName": null, + "type": "string", + "required": true, + "summary": "Cursor to clear.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "sql" + ], + "name": "delete-async", + "summary": "Delete an async SQL search.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "sql" + ], + "name": "get-async", + "summary": "Get async SQL search results.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delimiter", + "shortName": null, + "type": "string", + "required": false, + "summary": "The separator for CSV results. The API supports this parameter only for CSV responses.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "format", + "shortName": null, + "type": "string", + "required": false, + "summary": "The format for the response. You must specify a format using this parameter or the `Accept` HTTP header. If you specify both, the API uses this parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-alive", + "shortName": null, + "type": "string", + "required": false, + "summary": "The retention period for the search and its results. It defaults to the `keep_alive` period for the original SQL search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "sql" + ], + "name": "get-async-status", + "summary": "Get the async SQL search status.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "sql" + ], + "name": "query", + "summary": "Get SQL search results.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "format", + "shortName": null, + "type": "string", + "required": false, + "summary": "The format for the response. You can also specify a format using the `Accept` HTTP header. If you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-partial-search-results", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response has partial results when there are shard request timeouts or shard failures. If `false`, the API returns an error with no partial results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "catalog", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "columnar", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results. The API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cursor", + "shortName": null, + "type": "string", + "required": false, + "summary": "The cursor used to retrieve a set of paginated results. If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters. It ignores other request body parameters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fetch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of rows (or entries) to return in one response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-multi-value-leniency", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `false`, the API returns an exception when encountering multiple values for a field. If `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "The Elasticsearch query DSL for additional filtering.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-using-frozen", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the search can run on frozen indices.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-alive", + "shortName": null, + "type": "string", + "required": false, + "summary": "The retention period for an async or saved synchronous search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-on-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter. If `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The minimum retention period for the scroll cursor. After this time period, a pagination request might fail because the scroll cursor is no longer available. Subsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "array", + "required": false, + "summary": "The values for parameters in the query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "The SQL query to run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "request-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The timeout before the request fails.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "One or more runtime fields for the search request. These fields take precedence over mapped fields with the same name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "time-zone", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ISO-8601 time zone ID for the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion-timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results. If the search doesn't finish within this period, the search becomes async. To save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "sql" + ], + "name": "translate", + "summary": "Translate SQL into Elasticsearch queries.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "fetch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of rows (or entries) to return in one response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "The Elasticsearch query DSL for additional filtering.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": true, + "summary": "The SQL query to run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "time-zone", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ISO-8601 time zone ID for the search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "synonyms", + "summary": "Elasticsearch synonyms API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "synonyms" + ], + "name": "delete-synonym", + "summary": "Delete a synonym set.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The synonyms set identifier to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "synonyms" + ], + "name": "delete-synonym-rule", + "summary": "Delete a synonym rule.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "set-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the synonym set to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the synonym rule to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning. If `false`, analyzers will not be reloaded with the deleted synonym rule", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "synonyms" + ], + "name": "get-synonym", + "summary": "Get a synonym set.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The synonyms set identifier to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "The starting offset for query rules to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The max number of query rules to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "synonyms" + ], + "name": "get-synonym-rule", + "summary": "Get a synonym rule.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "set-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the synonym set to retrieve the synonym rule from.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the synonym rule to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "synonyms" + ], + "name": "get-synonyms-sets", + "summary": "Get all synonym sets.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "The starting offset for synonyms sets to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of synonyms sets to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "synonyms" + ], + "name": "put-synonym", + "summary": "Create or update a synonym set.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the synonyms set to be created or updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning. If `false`, analyzers will not be reloaded with the new synonym set", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "synonyms-set", + "shortName": null, + "type": "object", + "required": true, + "summary": "The synonym rules definitions for the synonyms set.", + "defaultValue": null, + "repeatable": true, + "separator": ",", + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "synonyms" + ], + "name": "put-synonym-rule", + "summary": "Create or update a synonym rule.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "set-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the synonym set.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the synonym rule to be updated or created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning. If `false`, analyzers will not be reloaded with the new synonym rule", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "synonyms", + "shortName": null, + "type": "string", + "required": true, + "summary": "The synonym rule information definition, which must be in Solr format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "tasks", + "summary": "Elasticsearch tasks API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "tasks" + ], + "name": "get", + "summary": "Get task information.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The task identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the request blocks until the task has completed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "transform", + "summary": "Elasticsearch transform API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "delete-transform", + "summary": "Delete a transform.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete-dest-index", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If this value is true, the destination index is deleted together with the transform. If false, the destination index will not be deleted", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "get-node-stats", + "summary": "Get node stats.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "get-transform", + "summary": "Get transforms.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using `_all`, by specifying `*` as the ``, or by omitting the ``.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of transforms.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of transforms to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-generated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "get-transform-stats", + "summary": "Get transform stats.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using `_all`, by specifying `*` as the ``, or by omitting the ``.", + "defaultValue": null, + "repeatable": true, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "Skips the specified number of transforms.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Specifies the maximum number of transforms to obtain.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Controls the time to wait for the stats", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "preview-transform", + "summary": "Preview a transform.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in the request body.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dest", + "shortName": null, + "type": "object", + "required": false, + "summary": "The destination for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Free text description of the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "frequency", + "shortName": null, + "type": "string", + "required": false, + "summary": "The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pivot", + "shortName": null, + "type": "object", + "required": false, + "summary": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "object", + "required": false, + "summary": "The source of the data for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines optional transform settings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sync", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the properties transforms require to run continuously.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "retention-policy", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "latest", + "shortName": null, + "type": "object", + "required": false, + "summary": "The latest method transforms the data by finding the latest document for each unique key.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "put-transform", + "summary": "Create a transform.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "defer-validation", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dest", + "shortName": null, + "type": "object", + "required": true, + "summary": "The destination for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Free text description of the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "frequency", + "shortName": null, + "type": "string", + "required": false, + "summary": "The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is `1s` and the maximum is `1h`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "latest", + "shortName": null, + "type": "object", + "required": false, + "summary": "The latest method transforms the data by finding the latest document for each unique key.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines optional transform metadata.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pivot", + "shortName": null, + "type": "object", + "required": false, + "summary": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "retention-policy", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines optional transform settings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "object", + "required": true, + "summary": "The source of the data for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sync", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the properties transforms require to run continuously.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "reset-transform", + "summary": "Reset a transform.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform must be stopped before it can be reset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "schedule-now-transform", + "summary": "Schedule a transform to start now.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Controls the time to wait for the scheduling to take place", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "defer", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, defers the scheduling by the transform's configured sync delay instead of triggering immediately. The transform will process new data after the delay elapses rather than right away.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "start-transform", + "summary": "Start a transform.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": false, + "summary": "Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "stop-transform", + "summary": "Stop transforms.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, use `_all` or `*` as the identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "allow-no-match", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If it is true, the API returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms. If it is false, the request returns a 404 status code when there are no matches or only partial matches.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If it is true, the API forcefully stops the transforms.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-checkpoint", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, the transform stops as soon as possible.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait-for-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "update-transform", + "summary": "Update a transform.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "transform-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "defer-validation", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dest", + "shortName": null, + "type": "object", + "required": false, + "summary": "The destination for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Free text description of the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "frequency", + "shortName": null, + "type": "string", + "required": false, + "summary": "The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines optional transform metadata.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "object", + "required": false, + "summary": "The source of the data for the transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines optional transform settings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sync", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines the properties transforms require to run continuously.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "retention-policy", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "helpers", + "summary": "High-level helper commands for common Elasticsearch workflows", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "es", + "helpers" + ], + "name": "scroll-search", + "summary": "Scroll through all search results, streaming documents as NDJSON to stdout, or returning a single JSON object when --json is set.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Target index", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "Query DSL clause as JSON (wrapped under \"query\"), e.g. '{\"match_all\":{}}'", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "Path to a file containing the full search body JSON (may include query, sort, aggs, ...)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scroll", + "shortName": null, + "type": "string", + "required": false, + "summary": "Scroll keep-alive duration", + "defaultValue": "1m", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Documents per scroll batch", + "defaultValue": "1000", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-docs", + "shortName": null, + "type": "number", + "required": false, + "summary": "Maximum total documents to fetch (default: unlimited)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "helpers" + ], + "name": "bulk-ingest", + "summary": "Bulk-ingest documents from file, directory, or stdin with automatic batching, concurrency, and retries.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": true, + "summary": "Target index", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "Path to data file (NDJSON or JSON array)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-dir", + "shortName": null, + "type": "string", + "required": false, + "summary": "Path to directory of data files to ingest", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "glob", + "shortName": null, + "type": "string", + "required": false, + "summary": "Glob pattern for --data-dir file matching", + "defaultValue": "**/*.json", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "no-recursive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Do not recurse into subdirectories when using --data-dir", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flush-bytes", + "shortName": null, + "type": "number", + "required": false, + "summary": "Batch size threshold in bytes", + "defaultValue": "5242880", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "concurrency", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of parallel bulk requests", + "defaultValue": "5", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "retries", + "shortName": null, + "type": "number", + "required": false, + "summary": "Max retries per failed batch", + "defaultValue": "3", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "retry-delay", + "shortName": null, + "type": "number", + "required": false, + "summary": "Initial retry delay in ms (doubles each attempt)", + "defaultValue": "1000", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pipeline", + "shortName": null, + "type": "string", + "required": false, + "summary": "Ingest pipeline name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "Custom routing value", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "es", + "helpers" + ], + "name": "msearch", + "summary": "Batch multiple search requests via _msearch with configurable batch size and concurrency.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "index", + "shortName": null, + "type": "string", + "required": false, + "summary": "Default index for searches", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "Path to JSON file with search array", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Searches per _msearch request", + "defaultValue": "5", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "concurrency", + "shortName": null, + "type": "number", + "required": false, + "summary": "Parallel _msearch requests", + "defaultValue": "5", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + } + ] + }, + { + "segment": "kb", + "summary": "Interact with the Kibana API", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "agent-builder", + "summary": "Kibana agent-builder API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-a2a-agentid", + "summary": "Send A2A task", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the agent to send the A2A task to.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-a2a-agentid-json", + "summary": "Get A2A agent card", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the agent to get A2A metadata for.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-agents", + "summary": "List agents", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-agents", + "summary": "Create an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "avatar-color", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional hex color code for the agent avatar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "avatar-symbol", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional symbol/initials for the agent avatar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "configuration", + "shortName": null, + "type": "object", + "required": true, + "summary": "Configuration settings for the agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Description of what the agent does.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Unique identifier for the agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "labels", + "shortName": null, + "type": "array", + "required": false, + "summary": "Optional labels for categorizing and organizing agents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Display name for the agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "visibility", + "shortName": null, + "type": "string", + "required": false, + "summary": "**Technical Preview; added in 9.4.0.** Optional visibility setting: `public` (any privileged user can read/write), `shared` (any privileged user can read, only owner can write), `private` (only owner can read/write).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-agents-agent-id-consumption", + "summary": "Get agent consumption data", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "has-warnings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Filter to conversations with or without high-token warnings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "Free-text search filter on conversation title.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "array", + "required": false, + "summary": "Cursor for pagination. Pass the search_after value from the previous response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of results per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field to sort results by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort direction.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "usernames", + "shortName": null, + "type": "array", + "required": false, + "summary": "Filter results to conversations by these usernames.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "delete-agent-builder-agents-id", + "summary": "Delete an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the agent to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-agents-id", + "summary": "Get an agent by ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the agent to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "put-agent-builder-agents-id", + "summary": "Update an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the agent to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "avatar-color", + "shortName": null, + "type": "string", + "required": false, + "summary": "Updated hex color code for the agent avatar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "avatar-symbol", + "shortName": null, + "type": "string", + "required": false, + "summary": "Updated symbol/initials for the agent avatar.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "configuration", + "shortName": null, + "type": "object", + "required": false, + "summary": "Updated configuration settings for the agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Updated description of what the agent does.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "labels", + "shortName": null, + "type": "array", + "required": false, + "summary": "Updated labels for categorizing and organizing agents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Updated display name for the agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "visibility", + "shortName": null, + "type": "string", + "required": false, + "summary": "**Technical Preview; added in 9.4.0.** Updated visibility setting: `public` (any privileged user can read/write), `shared` (any privileged user can read, only owner can write), `private` (only owner can read/write).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-conversations", + "summary": "List conversations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional agent ID to filter conversations by a specific agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "delete-agent-builder-conversations-conversation-id", + "summary": "Delete conversation by ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-conversations-conversation-id", + "summary": "Get conversation by ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-conversations-conversation-id-attachments", + "summary": "List conversation attachments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-deleted", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include deleted attachments in the list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-conversations-conversation-id-attachments", + "summary": "Create conversation attachment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Human-readable description of the attachment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "hidden", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether the attachment should be hidden from the user.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional custom ID for the attachment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "origin", + "shortName": null, + "type": "string", + "required": false, + "summary": "Origin string (for example, saved object ID) for by-reference attachments. When provided without data, the content is resolved once at creation time.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the attachment (e.g., text, esql, visualization).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "delete-agent-builder-conversations-conversation-id-attachments-attachment-id", + "summary": "Delete conversation attachment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the attachment to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "permanent", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, permanently removes the attachment (only for unreferenced attachments).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "patch-agent-builder-conversations-conversation-id-attachments-attachment-id", + "summary": "Rename attachment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the attachment to rename.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "The new description/name for the attachment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "put-agent-builder-conversations-conversation-id-attachments-attachment-id", + "summary": "Update conversation attachment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the attachment to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional new description for the attachment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-conversations-conversation-id-attachments-attachment-id-restore", + "summary": "Restore deleted attachment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the attachment to restore.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "put-agent-builder-conversations-conversation-id-attachments-attachment-id-origin", + "summary": "Update attachment origin", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the attachment to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "origin", + "shortName": null, + "type": "string", + "required": true, + "summary": "The origin string (e.g., saved object ID for visualizations and dashboards).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-conversations-conversation-id-attachments-stale", + "summary": "Check attachment staleness", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-converse", + "summary": "Send chat message", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-mode", + "shortName": null, + "type": "string", + "required": false, + "summary": "**Experimental; added in 9.4.0.** define how to execute the agent (local execution or via task_manager)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "action", + "shortName": null, + "type": "string", + "required": false, + "summary": "The action to perform. \"regenerate\" re-executes the last round with the original input. Requires conversation_id.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the agent to chat with. Defaults to the default Elastic AI agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachments", + "shortName": null, + "type": "array", + "required": false, + "summary": "**Technical Preview; added in 9.3.0.** Optional attachments to send with the message.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "browser-api-tools", + "shortName": null, + "type": "array", + "required": false, + "summary": "Optional browser API tools to be registered as LLM tools with browser.* namespace. These tools execute on the client side.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "capabilities", + "shortName": null, + "type": "object", + "required": false, + "summary": "Controls agent capabilities during conversation. Currently supports visualization rendering for tabular tool results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "configuration-overrides", + "shortName": null, + "type": "object", + "required": false, + "summary": "Runtime configuration overrides. These override the stored agent configuration for this execution only.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional connector ID for the agent to use for external integrations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional existing conversation ID to continue a previous conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "string", + "required": false, + "summary": "The user input message to send to the agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prompts", + "shortName": null, + "type": "object", + "required": false, + "summary": "Can be used to respond to a confirmation prompt.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-converse-async", + "summary": "Send chat message (streaming)", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-mode", + "shortName": null, + "type": "string", + "required": false, + "summary": "**Experimental; added in 9.4.0.** define how to execute the agent (local execution or via task_manager)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "action", + "shortName": null, + "type": "string", + "required": false, + "summary": "The action to perform. \"regenerate\" re-executes the last round with the original input. Requires conversation_id.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the agent to chat with. Defaults to the default Elastic AI agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachments", + "shortName": null, + "type": "array", + "required": false, + "summary": "**Technical Preview; added in 9.3.0.** Optional attachments to send with the message.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "browser-api-tools", + "shortName": null, + "type": "array", + "required": false, + "summary": "Optional browser API tools to be registered as LLM tools with browser.* namespace. These tools execute on the client side.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "capabilities", + "shortName": null, + "type": "object", + "required": false, + "summary": "Controls agent capabilities during conversation. Currently supports visualization rendering for tabular tool results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "configuration-overrides", + "shortName": null, + "type": "object", + "required": false, + "summary": "Runtime configuration overrides. These override the stored agent configuration for this execution only.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional connector ID for the agent to use for external integrations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional existing conversation ID to continue a previous conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "string", + "required": false, + "summary": "The user input message to send to the agent.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prompts", + "shortName": null, + "type": "object", + "required": false, + "summary": "Can be used to respond to a confirmation prompt.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-mcp", + "summary": "MCP server", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "namespace", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma-separated list of namespaces to filter tools. Only tools matching the specified namespaces will be returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-plugins", + "summary": "List plugins", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "delete-agent-builder-plugins-pluginid", + "summary": "Delete a plugin", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "plugin-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the plugin.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, removes the plugin skills from agents that use them and then deletes the plugin. If false and any agent uses the plugin skills, the request returns 409 Conflict with the list of agents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-plugins-pluginid", + "summary": "Get a plugin by id", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "plugin-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the plugin.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-plugins-install", + "summary": "Install a plugin", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "plugin-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional name override for the plugin. Defaults to the manifest name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "url", + "shortName": null, + "type": "string", + "required": true, + "summary": "URL to install the plugin from (GitHub URL or direct zip URL).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-skills", + "summary": "List skills", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "include-plugins", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Set to true to include skills from plugins.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-skills", + "summary": "Create a skill", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "content", + "shortName": null, + "type": "string", + "required": true, + "summary": "Skill instructions content (markdown).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Description of what the skill does.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Unique identifier for the skill.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Human-readable name for the skill.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "referenced-content", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tool-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "Tool IDs from the tool registry that this skill references.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "delete-agent-builder-skills-skillid", + "summary": "Delete a skill", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "skill-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the skill.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, removes the skill from agents that use it and then deletes it. If false and any agent uses the skill, the request returns 409 Conflict with the list of agents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-skills-skillid", + "summary": "Get a skill by id", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "skill-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the skill.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "put-agent-builder-skills-skillid", + "summary": "Update a skill", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "skill-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the skill.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "content", + "shortName": null, + "type": "string", + "required": false, + "summary": "Updated skill instructions content.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Updated description.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Updated name for the skill.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "referenced-content", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tool-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "Updated tool IDs from the tool registry.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-tools", + "summary": "List tools", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-tools", + "summary": "Create a tool", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "configuration", + "shortName": null, + "type": "object", + "required": true, + "summary": "Tool-specific configuration parameters. See examples for details.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Description of what the tool does.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Unique identifier for the tool.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "Optional tags for categorizing and organizing tools.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of tool to create (e.g., esql, index_search).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "post-agent-builder-tools-execute", + "summary": "Run a tool", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional connector ID for tools that require external integrations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tool-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the tool to execute.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tool-params", + "shortName": null, + "type": "object", + "required": true, + "summary": "Parameters to pass to the tool execution. See examples for details", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "delete-agent-builder-tools-toolid", + "summary": "Delete a tool", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "tool-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the tool to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, removes the tool from agents that use it and then deletes it. If false and any agent uses the tool, the request returns 409 Conflict with the list of agents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "get-agent-builder-tools-toolid", + "summary": "Get a tool by id", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "tool-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the tool to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "agent-builder" + ], + "name": "put-agent-builder-tools-toolid", + "summary": "Update a tool", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "tool-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the tool to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "configuration", + "shortName": null, + "type": "object", + "required": false, + "summary": "Updated tool-specific configuration parameters. See examples for details.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Updated description of what the tool does.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "Updated tags for categorizing and organizing tools.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "alerting", + "summary": "Kibana alerting API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "delete-alerting-rule-id", + "summary": "Delete a rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "get-alerting-rule-id", + "summary": "Get rule details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-id", + "summary": "Create a rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule. If it is omitted, an ID is randomly generated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "actions", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-delay", + "shortName": null, + "type": "object", + "required": false, + "summary": "Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "artifacts", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "consumer", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether you want to run the rule on an interval basis after it is created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flapping", + "shortName": null, + "type": "object", + "required": false, + "summary": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "notify-when", + "shortName": null, + "type": "string", + "required": false, + "summary": "Indicates how often alerts generate actions. Valid values include: `onActionGroupChange`: Actions run when the alert status changes; `onActiveAlert`: Actions run when the alert becomes active and at each check interval while the rule conditions are met; `onThrottleInterval`: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: You cannot specify `notify_when` at both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-type-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The rule type identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "schedule", + "shortName": null, + "type": "object", + "required": true, + "summary": "The check interval, which specifies how frequently the rule conditions are checked.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "The tags for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "throttle", + "shortName": null, + "type": "string", + "required": false, + "summary": "Use the `throttle` property in the action `frequency` object instead. The throttle interval, which defines how often an alert generates repeated actions. NOTE: You cannot specify the throttle interval at both the rule and action level. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "string", + "required": false, + "summary": "The parameters for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "put-alerting-rule-id", + "summary": "Update a rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "actions", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-delay", + "shortName": null, + "type": "object", + "required": false, + "summary": "Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "artifacts", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "flapping", + "shortName": null, + "type": "object", + "required": false, + "summary": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "notify-when", + "shortName": null, + "type": "string", + "required": false, + "summary": "Indicates how often alerts generate actions. Valid values include: `onActionGroupChange`: Actions run when the alert status changes; `onActiveAlert`: Actions run when the alert becomes active and at each check interval while the rule conditions are met; `onThrottleInterval`: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: You cannot specify `notify_when` at both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "object", + "required": false, + "summary": "The parameters for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "schedule", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "throttle", + "shortName": null, + "type": "string", + "required": false, + "summary": "Use the `throttle` property in the action `frequency` object instead. The throttle interval, which defines how often an alert generates repeated actions. NOTE: You cannot specify the throttle interval at both the rule and action level. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-id-disable", + "summary": "Disable a rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "untrack", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Defines whether this rule's alerts should be untracked.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-id-enable", + "summary": "Enable a rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-id-mute-all", + "summary": "Mute all alerts", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-id-unmute-all", + "summary": "Unmute all alerts", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-id-update-api-key", + "summary": "Update the API key for a rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-id-snooze-schedule", + "summary": "Schedule a snooze for the rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier of the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "schedule", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-rule-id-alert-alert-id-mute", + "summary": "Mute an alert", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the alert.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "validate-alerts-existence", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to validate the existence of the alert.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rule-rule-id-alert-alert-id-unmute", + "summary": "Unmute an alert", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the alert.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "delete-alerting-rule-ruleid-snooze-schedule-scheduleid", + "summary": "Delete a snooze schedule for a rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the rule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "schedule-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the snooze schedule.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "get-alerting-rules-find", + "summary": "Get information about rules", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of rules to return per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "An Elasticsearch simple_query_string query that filters the objects in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "default-search-operator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The default operator to use for the simple_query_string.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "The fields to perform the simple_query_string parsed query against.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines which field is used to sort the results. The field must exist in the `attributes` key of the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines the sort order.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "has-reference", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the rules that have a relation with the reference objects with a specific type and identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "The fields to return in the `attributes` key of the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "A KQL string that you filter with an attribute from your saved object. It should look like `savedObjectType.attributes.title: \"myTitle\"`. However, if you used a direct attribute of a saved object, such as `updatedAt`, you must define your filter, for example, `savedObjectType.updatedAt > 2018-12-22`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter-consumers", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rules-backfill-find", + "summary": "Find backfills for rules", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "The end date for filtering backfills.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of backfills to return per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "A comma-separated list of rule identifiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "initiator", + "shortName": null, + "type": "string", + "required": false, + "summary": "The initiator of the backfill, either `user` for manual backfills or `system` for automatic gap fills.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "The start date for filtering backfills.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to sort backfills by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "The sort order.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "post-alerting-rules-backfill-schedule", + "summary": "Schedule a backfill for rules", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "delete-alerting-rules-backfill-id", + "summary": "Delete a backfill by ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the backfill.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "alerting" + ], + "name": "get-alerting-rules-backfill-id", + "summary": "Get a backfill by ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the backfill.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "apm-agent-configuration", + "summary": "Kibana apm-agent-configuration API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "apm-agent-configuration" + ], + "name": "delete-agent-configuration", + "summary": "Delete agent configuration", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "object", + "required": true, + "summary": "Service", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-agent-configuration" + ], + "name": "get-agent-configurations", + "summary": "Get a list of agent configurations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-agent-configuration" + ], + "name": "create-update-agent-configuration", + "summary": "Create or update agent configuration", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "overwrite", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If the config exists ?overwrite=true is required", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The agent name is used by the UI to determine which settings to display.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "object", + "required": true, + "summary": "Service", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": true, + "summary": "Agent configuration settings", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-agent-configuration" + ], + "name": "get-agent-name-for-service", + "summary": "Get agent name for service", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "service-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the service", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-agent-configuration" + ], + "name": "get-environments-for-service", + "summary": "Get environments for service", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "service-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of the service", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-agent-configuration" + ], + "name": "search-single-configuration", + "summary": "Lookup single agent configuration", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "etag", + "shortName": null, + "type": "string", + "required": false, + "summary": "If etags match then `applied_by_agent` field will be set to `true`", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "mark-as-applied-by-agent", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "`markAsAppliedByAgent=true` means \"force setting it to true regardless of etag\".", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "object", + "required": true, + "summary": "Service", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-agent-configuration" + ], + "name": "get-single-agent-configuration", + "summary": "Get single agent configuration", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Service name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "environment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Service environment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "apm-agent-keys", + "summary": "Kibana apm-agent-keys API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "apm-agent-keys" + ], + "name": "create-agent-key", + "summary": "Create an APM agent key", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the APM agent key.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "privileges", + "shortName": null, + "type": "array", + "required": true, + "summary": "The APM agent key privileges. It can take one or more of the following values:", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "apm-annotations", + "summary": "Kibana apm-annotations API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "apm-annotations" + ], + "name": "create-annotation", + "summary": "Create a service annotation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "service-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the service", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "@timestamp", + "shortName": null, + "type": "string", + "required": true, + "summary": "The date and time of the annotation. It must be in ISO 8601 format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "message", + "shortName": null, + "type": "string", + "required": false, + "summary": "The message displayed in the annotation. It defaults to `service.version`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "service", + "shortName": null, + "type": "object", + "required": true, + "summary": "The service that identifies the configuration to create or update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "Tags are used by the Applications UI to distinguish APM annotations from other annotations. Tags may have additional functionality in future releases. It defaults to `[apm]`. While you can add additional tags, you cannot remove the `apm` tag.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-annotations" + ], + "name": "get-annotation", + "summary": "Search for annotations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "service-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the service", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "environment", + "shortName": null, + "type": "string", + "required": false, + "summary": "The environment to filter annotations by", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "The start date for the search", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "The end date for the search", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "apm-server-schema", + "summary": "Kibana apm-server-schema API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "apm-server-schema" + ], + "name": "save-apm-server-schema", + "summary": "Save APM server schema", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "schema", + "shortName": null, + "type": "object", + "required": false, + "summary": "Schema object", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "apm-sourcemaps", + "summary": "Kibana apm-sourcemaps API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "apm-sourcemaps" + ], + "name": "get-source-maps", + "summary": "Get source maps", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of records per page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-sourcemaps" + ], + "name": "upload-source-map", + "summary": "Upload a source map", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "apm-sourcemaps" + ], + "name": "delete-source-map", + "summary": "Delete source map", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Source map identifier", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "connectors", + "summary": "Kibana connectors API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "connectors" + ], + "name": "get-actions-connector-types", + "summary": "Get connector types", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "feature-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "connectors" + ], + "name": "get-actions-connector-oauth-callback", + "summary": "Handle OAuth callback", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "code", + "shortName": null, + "type": "string", + "required": false, + "summary": "The authorization code returned by the OAuth provider.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "state", + "shortName": null, + "type": "string", + "required": false, + "summary": "The state parameter for CSRF protection.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "error", + "shortName": null, + "type": "string", + "required": false, + "summary": "Error code if the authorization failed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "error-description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Human-readable error description.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "session-state", + "shortName": null, + "type": "string", + "required": false, + "summary": "Session state from the OAuth provider (e.g., Microsoft).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "connectors" + ], + "name": "delete-actions-connector-id", + "summary": "Delete a connector", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "connectors" + ], + "name": "get-actions-connector-id", + "summary": "Get connector information", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "connectors" + ], + "name": "post-actions-connector-id", + "summary": "Create a connector", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-type-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The display name for the connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-config", + "shortName": null, + "type": "string", + "required": false, + "summary": "The connector configuration details.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "secrets", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "connectors" + ], + "name": "put-actions-connector-id", + "summary": "Update a connector", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The display name for the connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-config", + "shortName": null, + "type": "string", + "required": false, + "summary": "The connector configuration details.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "secrets", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "connectors" + ], + "name": "post-actions-connector-id-execute", + "summary": "Run a connector", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "An identifier for the connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "connectors" + ], + "name": "get-actions-connectors", + "summary": "Get all connectors", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "data-streams", + "summary": "Kibana data-streams API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "data-streams" + ], + "name": "get-fleet-data-streams", + "summary": "Get data streams", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-streams" + ], + "name": "get-fleet-epm-data-streams", + "summary": "Get data streams", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dataset-query", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "uncategorised-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "data-views", + "summary": "Kibana data-views API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "get-all-data-views-default", + "summary": "Get all data views", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "create-data-view-defaultw", + "summary": "Create a data view", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "data-view", + "shortName": null, + "type": "object", + "required": true, + "summary": "The data view object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "override", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Override an existing data view if a data view with the provided title already exists.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "delete-data-view-default", + "summary": "Delete a data view", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The viewId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "get-data-view-default", + "summary": "Get a data view", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The viewId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "update-data-view-default", + "summary": "Update a data view", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The viewId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-view", + "shortName": null, + "type": "object", + "required": true, + "summary": "The data view properties you want to update. Only the specified properties are updated in the data view. Unspecified fields stay as they are persisted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh-fields", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Reloads the data view fields after the data view is updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "update-fields-metadata-default", + "summary": "Update data view fields metadata", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The viewId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "object", + "required": true, + "summary": "The field object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "create-runtime-field-default", + "summary": "Create a runtime field", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The viewId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name for a runtime field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-field", + "shortName": null, + "type": "object", + "required": true, + "summary": "The runtime field definition object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "create-update-runtime-field-default", + "summary": "Create or update a runtime field", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the data view fields you want to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name for a runtime field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-field", + "shortName": null, + "type": "object", + "required": true, + "summary": "The runtime field definition object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "delete-runtime-field-default", + "summary": "Delete a runtime field from a data view", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The viewId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The fieldName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "get-runtime-field-default", + "summary": "Get a runtime field", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The viewId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The fieldName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "update-runtime-field-default", + "summary": "Update a runtime field", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The viewId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The fieldName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-field", + "shortName": null, + "type": "object", + "required": true, + "summary": "The runtime field definition object.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "get-default-data-view-default", + "summary": "Get the default data view", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "set-default-datail-view-default", + "summary": "Set the default data view", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "data-view-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The data view identifier. NOTE: The API does not validate whether it is a valid identifier. Use `null` to unset the default data view.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Update an existing default data view identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "swap-data-views-default", + "summary": "Swap saved object references", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "delete", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Deletes referenced saved object if all references are removed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "for-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Limit the affected saved objects to one or more by identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "for-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Limit the affected saved objects by type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The saved object reference to change.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "New saved object reference value to replace the old value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "preview-swap-data-views-default", + "summary": "Preview a saved object reference swap", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "delete", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Deletes referenced saved object if all references are removed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "for-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Limit the affected saved objects to one or more by identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "for-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Limit the affected saved objects by type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The saved object reference to change.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "New saved object reference value to replace the old value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "elastic-agent-actions", + "summary": "Kibana elastic-agent-actions API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-agentid-actions", + "summary": "Create an agent action", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "action", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-agentid-reassign", + "summary": "Reassign an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-agentid-request-diagnostics", + "summary": "Request agent diagnostics", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "additional-metrics", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-agentid-rollback", + "summary": "Rollback an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agent ID to rollback", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-agentid-unenroll", + "summary": "Unenroll an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "revoke", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-agentid-upgrade", + "summary": "Upgrade an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-rate-limit-check", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-uri", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "get-fleet-agents-action-status", + "summary": "Get an agent action status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "date", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "latest", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "error-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-actions-actionid-cancel", + "summary": "Cancel an agent action", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "action-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The actionId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-bulk-reassign", + "summary": "Bulk reassign agents", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agents", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-inactive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-bulk-request-diagnostics", + "summary": "Bulk request diagnostics from agents", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "additional-metrics", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agents", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-bulk-rollback", + "summary": "Bulk rollback agents", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agents", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-inactive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-bulk-unenroll", + "summary": "Bulk unenroll agents", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agents", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Unenrolls hosted agents too", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-inactive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When passing agents by KQL query, unenrolls inactive agents too", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "revoke", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Revokes API keys of agents", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-bulk-update-agent-tags", + "summary": "Bulk update agent tags", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agents", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-inactive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags-to-add", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags-to-remove", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-actions" + ], + "name": "post-fleet-agents-bulk-upgrade", + "summary": "Bulk upgrade agents", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agents", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-inactive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rollout-duration-seconds", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-rate-limit-check", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source-uri", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start-time", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "elastic-agent-binary-download-sources", + "summary": "Kibana elastic-agent-binary-download-sources API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "elastic-agent-binary-download-sources" + ], + "name": "get-fleet-agent-download-sources", + "summary": "Get agent binary download sources", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-binary-download-sources" + ], + "name": "post-fleet-agent-download-sources", + "summary": "Create an agent binary download source", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "auth", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "host", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-default", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "proxy-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the proxy to use for this download source. See the proxies API for more information.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "secrets", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ssl", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-binary-download-sources" + ], + "name": "delete-fleet-agent-download-sources-sourceid", + "summary": "Delete an agent binary download source", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "source-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sourceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-binary-download-sources" + ], + "name": "get-fleet-agent-download-sources-sourceid", + "summary": "Get an agent binary download source", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "source-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sourceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-binary-download-sources" + ], + "name": "put-fleet-agent-download-sources-sourceid", + "summary": "Update an agent binary download source", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "source-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sourceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "auth", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "host", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-default", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "proxy-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the proxy to use for this download source. See the proxies API for more information.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "secrets", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ssl", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "elastic-agent-policies", + "summary": "Kibana elastic-agent-policies API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "get-fleet-agent-policies", + "summary": "Get agent policies", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-upgradeable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "no-agent-count", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "use withAgentCount instead", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-agent-count", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "get policies with agent count", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "full", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "get full policies with package policies populated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "post-fleet-agent-policies", + "summary": "Create an agent policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "sys-monitoring", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "advanced-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-features", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agentless", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-output-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "download-source-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fleet-server-host-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "global-data-tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "User defined data tags that are added to all of the inputs. The values can be strings or numbers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "has-agent-version-conditions", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "has-fleet-server", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inactivity-timeout", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-default", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-default-fleet-server", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-managed", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-protected", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-verifier", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates this is a short-lived verifier policy used for OTel permission verification.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-monitoring-alive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When set to true, monitoring will be enabled but logs/metrics collection will be disabled", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-diagnostics", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-enabled", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-http", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-output-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-pprof-enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "overrides", + "shortName": null, + "type": "object", + "required": false, + "summary": "Override settings that are defined in the agent policy. Input settings cannot be overridden. The override option should be used only in unusual circumstances and not as a routine procedure.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "required-versions", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "space-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "supports-agentless", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether the agent policy supports agentless integrations. Deprecated in favor of the Fleet agentless policies API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "unenroll-timeout", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "post-fleet-agent-policies-bulk-get", + "summary": "Bulk get agent policies", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "full", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "get full policies with package policies populated", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "list of package policy ids", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "get-fleet-agent-policies-agentpolicyid", + "summary": "Get an agent policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentPolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "put-fleet-agent-policies-agentpolicyid", + "summary": "Update an agent policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentPolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "advanced-settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-features", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agentless", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "bump-revision", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data-output-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "download-source-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fleet-server-host-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "global-data-tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "User defined data tags that are added to all of the inputs. The values can be strings or numbers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "has-agent-version-conditions", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "has-fleet-server", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inactivity-timeout", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-default", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-default-fleet-server", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-managed", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-protected", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-verifier", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates this is a short-lived verifier policy used for OTel permission verification.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-monitoring-alive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When set to true, monitoring will be enabled but logs/metrics collection will be disabled", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-diagnostics", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-enabled", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-http", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-output-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "monitoring-pprof-enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "overrides", + "shortName": null, + "type": "object", + "required": false, + "summary": "Override settings that are defined in the agent policy. Input settings cannot be overridden. The override option should be used only in unusual circumstances and not as a routine procedure.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "required-versions", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "space-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "supports-agentless", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether the agent policy supports agentless integrations. Deprecated in favor of the Fleet agentless policies API.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "unenroll-timeout", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "get-fleet-agent-policies-agentpolicyid-auto-upgrade-agents-status", + "summary": "Get auto upgrade agent status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentPolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "post-fleet-agent-policies-agentpolicyid-copy", + "summary": "Copy an agent policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentPolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "get-fleet-agent-policies-agentpolicyid-download", + "summary": "Download an agent policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentPolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "download", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns the policy as a downloadable file", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "standalone", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns the policy formatted for standalone agents", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kubernetes", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns the policy formatted for Kubernetes deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "revision", + "shortName": null, + "type": "number", + "required": false, + "summary": "If provided, returns the policy at the specified revision. Cannot be used with standalone or kubernetes flags.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "get-fleet-agent-policies-agentpolicyid-full", + "summary": "Get a full agent policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentPolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "download", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns the policy as a downloadable file", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "standalone", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns the policy formatted for standalone agents", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kubernetes", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, returns the policy formatted for Kubernetes deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "revision", + "shortName": null, + "type": "number", + "required": false, + "summary": "If provided, returns the policy at the specified revision. Cannot be used with standalone or kubernetes flags.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "get-fleet-agent-policies-agentpolicyid-outputs", + "summary": "Get outputs for an agent policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentPolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "post-fleet-agent-policies-delete", + "summary": "Delete an agent policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "bypass validation checks that can prevent agent policy deletion", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "post-fleet-agent-policies-outputs", + "summary": "Get outputs for agent policies", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "list of package policy ids", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "get-fleet-kubernetes", + "summary": "Get a full K8s agent manifest", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "download", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fleet-server", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enrol-token", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agent-policies" + ], + "name": "get-fleet-kubernetes-download", + "summary": "Download an agent manifest", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "download", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fleet-server", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enrol-token", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "elastic-agent-status", + "summary": "Kibana elastic-agent-status API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "elastic-agent-status" + ], + "name": "get-fleet-agent-status", + "summary": "Get an agent status summary", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "policy-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "policy-ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "elastic-agents", + "summary": "Kibana elastic-agents API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "get-fleet-agent-status-data", + "summary": "Get incoming agent data", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agents-ids", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "preview-data", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "get-fleet-agents", + "summary": "Get agents", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-agentless", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-inactive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-metrics", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-upgradeable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "get-status-summary", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "open-pit", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pit-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pit-keep-alive", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "post-fleet-agents", + "summary": "Get agents by action ids", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "action-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "delete-fleet-agents-agentid", + "summary": "Delete an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "get-fleet-agents-agentid", + "summary": "Get an agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-metrics", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "put-fleet-agents-agentid", + "summary": "Update an agent by ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "user-provided-metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "post-fleet-agents-agentid-migrate", + "summary": "Migrate a single agent", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enrollment-token", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "uri", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "post-fleet-agents-agentid-privilege-level-change", + "summary": "Change agent privilege level", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agent ID to change privilege level for", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "user-info", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "get-fleet-agents-agentid-uploads", + "summary": "Get agent uploads", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The agentId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "get-fleet-agents-available-versions", + "summary": "Get available agent versions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "post-fleet-agents-bulk-migrate", + "summary": "Migrate multiple agents", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agents", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enrollment-token", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "uri", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "post-fleet-agents-bulk-privilege-level-change", + "summary": "Bulk change agent privilege level", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agents", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "batch-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "user-info", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "delete-fleet-agents-files-fileid", + "summary": "Delete an uploaded file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "file-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The fileId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "get-fleet-agents-files-fileid-filename", + "summary": "Get an uploaded file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "file-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The fileId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "file-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The fileName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "get-fleet-agents-setup", + "summary": "Get agent setup info", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "post-fleet-agents-setup", + "summary": "Initiate agent setup", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-agents" + ], + "name": "get-fleet-agents-tags", + "summary": "Get agent tags", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-inactive", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "elastic-package-manager-epm", + "summary": "Kibana elastic-package-manager-epm API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-bulk-assets", + "summary": "Bulk get assets", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "asset-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-categories", + "summary": "Get package categories", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-policy-templates", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-custom-integrations", + "summary": "Create a custom integration", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "datasets", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "integration-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "put-fleet-epm-custom-integrations-pkgname", + "summary": "Update a custom integration", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "categories", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "read-me-data", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages", + "summary": "Get packages", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "category", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-install-status", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-package-policies-count", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages", + "summary": "Install a package by upload", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ignore-mapping-update-errors", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-data-stream-rollover", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-bulk", + "summary": "Bulk install packages", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "packages", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-bulk-rollback", + "summary": "Bulk rollback packages", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "packages", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-bulk-rollback-taskid", + "summary": "Get Bulk rollback packages details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Task ID of the bulk operation", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-bulk-uninstall", + "summary": "Bulk uninstall packages", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "packages", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-bulk-uninstall-taskid", + "summary": "Get Bulk uninstall packages details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Task ID of the bulk operation", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-bulk-upgrade", + "summary": "Bulk upgrade packages", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "packages", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "upgrade-package-policies", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-bulk-upgrade-taskid", + "summary": "Get Bulk upgrade packages details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Task ID of the bulk operation", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "delete-fleet-epm-packages-pkgname", + "summary": "Delete a package", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-pkgname", + "summary": "Get a package", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unverified", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "full", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-pkgname", + "summary": "Install a package from the registry", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-mapping-update-errors", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-data-stream-rollover", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-dependency-check", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Skip dependency validation when installing a package with dependencies", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-constraints", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "put-fleet-epm-packages-pkgname", + "summary": "Update package settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-policies-up-to-date", + "shortName": null, + "type": "boolean", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "delete-fleet-epm-packages-pkgname-pkgversion", + "summary": "Delete a package", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-pkgname-pkgversion", + "summary": "Get a package", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unverified", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "full", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-pkgname-pkgversion", + "summary": "Install a package from the registry", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-mapping-update-errors", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-data-stream-rollover", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-dependency-check", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Skip dependency validation when installing a package with dependencies", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-constraints", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "put-fleet-epm-packages-pkgname-pkgversion", + "summary": "Update package settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "keep-policies-up-to-date", + "shortName": null, + "type": "boolean", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-pkgname-pkgversion-filepath", + "summary": "Get a package file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "file-path", + "shortName": null, + "type": "string", + "required": true, + "summary": "The filePath parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "delete-fleet-epm-packages-pkgname-pkgversion-datastream-assets", + "summary": "Delete assets for an input package", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "package-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "delete-fleet-epm-packages-pkgname-pkgversion-kibana-assets", + "summary": "Delete Kibana assets for a package", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-pkgname-pkgversion-kibana-assets", + "summary": "Install Kibana assets for a package", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "space-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "When provided install assets in the specified spaces instead of the current space.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-pkgname-pkgversion-rule-assets", + "summary": "Install Kibana alert rule for a package", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-pkgname-pkgversion-transforms-authorize", + "summary": "Authorize transforms", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "transforms", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-pkgname-review-upgrade", + "summary": "Review a pending policy upgrade for a package with deprecations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Package name to review upgrade for", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "action", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "target-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "post-fleet-epm-packages-pkgname-rollback", + "summary": "Rollback a package to previous version", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Package name to roll back", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-pkgname-stats", + "summary": "Get package stats", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-installed", + "summary": "Get installed packages", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "data-stream-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-only-active-data-streams", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name-query", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-packages-limited", + "summary": "Get a limited package list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-templates-pkgname-pkgversion-inputs", + "summary": "Get an inputs template", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "pkg-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgName parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pkg-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The pkgVersion parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-unverified", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "elastic-package-manager-epm" + ], + "name": "get-fleet-epm-verification-key-id", + "summary": "Get a package signature verification key ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-agentless-policies", + "summary": "Kibana fleet-agentless-policies API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-agentless-policies" + ], + "name": "post-fleet-agentless-policies", + "summary": "Create an agentless policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "The format of the response package policy.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "additional-datastreams-permissions", + "shortName": null, + "type": "array", + "required": false, + "summary": "Additional datastream permissions, that will be added to the agent policy.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cloud-connector", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Policy description.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Force package policy creation even if the package is not verified, or if the agent policy is managed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Policy unique identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inputs", + "shortName": null, + "type": "object", + "required": false, + "summary": "Package policy inputs. Refer to the integration documentation to know which inputs are available.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Unique name for the policy.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace", + "shortName": null, + "type": "string", + "required": false, + "summary": "Policy namespace. When not specified, it inherits the agent policy namespace.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "package", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "policy-template", + "shortName": null, + "type": "string", + "required": false, + "summary": "The policy template to use for the agentless package policy. If not provided, the default policy template will be used.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "var-group-selections", + "shortName": null, + "type": "object", + "required": false, + "summary": "Variable group selections. Maps var_group name to the selected option name within that group.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "vars", + "shortName": null, + "type": "object", + "required": false, + "summary": "Input/stream level variable. Refer to the integration documentation for more information.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-agentless-policies" + ], + "name": "delete-fleet-agentless-policies-policyid", + "summary": "Delete an agentless policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the policy to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Force delete the policy even if the policy is managed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-cloud-connectors", + "summary": "Kibana fleet-cloud-connectors API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-cloud-connectors" + ], + "name": "get-fleet-cloud-connectors", + "summary": "Get cloud connectors", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "string", + "required": false, + "summary": "The page number for pagination.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "string", + "required": false, + "summary": "The number of items per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "KQL query to filter cloud connectors.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-cloud-connectors" + ], + "name": "post-fleet-cloud-connectors", + "summary": "Create cloud connector", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "account-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The account type: single-account (single account/subscription) or organization-account (organization-wide).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cloud-provider", + "shortName": null, + "type": "string", + "required": true, + "summary": "The cloud provider type: aws, azure, or gcp.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the cloud connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "vars", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-cloud-connectors" + ], + "name": "delete-fleet-cloud-connectors-cloudconnectorid", + "summary": "Delete cloud connector (supports force deletion)", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "cloud-connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the cloud connector to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, forces deletion even if the cloud connector is in use.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-cloud-connectors" + ], + "name": "get-fleet-cloud-connectors-cloudconnectorid", + "summary": "Get cloud connector", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "cloud-connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the cloud connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-cloud-connectors" + ], + "name": "put-fleet-cloud-connectors-cloudconnectorid", + "summary": "Update cloud connector", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "cloud-connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the cloud connector to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "account-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The account type: single-account (single account/subscription) or organization-account (organization-wide).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of the cloud connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "vars", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-cloud-connectors" + ], + "name": "get-fleet-cloud-connectors-cloudconnectorid-usage", + "summary": "Get cloud connector usage (package policies using the connector)", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "cloud-connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier of the cloud connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number for pagination.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of items per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-enrollment-api-keys", + "summary": "Kibana fleet-enrollment-api-keys API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-enrollment-api-keys" + ], + "name": "get-fleet-enrollment-api-keys", + "summary": "Get enrollment API keys", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-enrollment-api-keys" + ], + "name": "post-fleet-enrollment-api-keys", + "summary": "Create an enrollment API key", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "expiration", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-enrollment-api-keys" + ], + "name": "delete-fleet-enrollment-api-keys-keyid", + "summary": "Revoke an enrollment API key", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "key-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The keyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-enrollment-api-keys" + ], + "name": "get-fleet-enrollment-api-keys-keyid", + "summary": "Get an enrollment API key", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "key-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The keyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-internals", + "summary": "Kibana fleet-internals API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-internals" + ], + "name": "get-fleet-check-permissions", + "summary": "Check permissions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "fleet-server-setup", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-internals" + ], + "name": "post-fleet-health-check", + "summary": "Check Fleet Server health", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-internals" + ], + "name": "get-fleet-settings", + "summary": "Get settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-internals" + ], + "name": "put-fleet-settings", + "summary": "Update settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "additional-yaml-config", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete-unenrolled-agents", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "has-seen-add-data-notice", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "integration-knowledge-enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kibana-ca-sha256", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kibana-urls", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prerelease-integrations-enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-internals" + ], + "name": "post-fleet-setup", + "summary": "Initiate Fleet setup", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-outputs", + "summary": "Kibana fleet-outputs API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-outputs" + ], + "name": "post-fleet-logstash-api-keys", + "summary": "Generate a Logstash API key", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-outputs" + ], + "name": "get-fleet-outputs", + "summary": "Get outputs", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-outputs" + ], + "name": "post-fleet-outputs", + "summary": "Create output", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-outputs" + ], + "name": "delete-fleet-outputs-outputid", + "summary": "Delete output", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "output-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The outputId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-outputs" + ], + "name": "get-fleet-outputs-outputid", + "summary": "Get output", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "output-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The outputId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-outputs" + ], + "name": "put-fleet-outputs-outputid", + "summary": "Update output", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "output-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The outputId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-outputs" + ], + "name": "get-fleet-outputs-outputid-health", + "summary": "Get the latest output health", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "output-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The outputId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-package-policies", + "summary": "Kibana fleet-package-policies API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "get-fleet-package-policies", + "summary": "Get package policies", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-upgradeable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-agent-count", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "post-fleet-package-policies", + "summary": "Create a package policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "post-fleet-package-policies-bulk-get", + "summary": "Bulk get package policies", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "list of package policy ids", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "delete-fleet-package-policies-packagepolicyid", + "summary": "Delete a package policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "package-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The packagePolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "get-fleet-package-policies-packagepolicyid", + "summary": "Get a package policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "package-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The packagePolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "put-fleet-package-policies-packagepolicyid", + "summary": "Update a package policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "package-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The packagePolicyId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-format", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "post-fleet-package-policies-delete", + "summary": "Bulk delete package policies", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "package-policy-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "post-fleet-package-policies-upgrade", + "summary": "Upgrade a package policy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "package-policy-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-package-policies" + ], + "name": "post-fleet-package-policies-upgrade-dryrun", + "summary": "Dry run a package policy upgrade", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "package-policy-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "package-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-proxies", + "summary": "Kibana fleet-proxies API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-proxies" + ], + "name": "get-fleet-proxies", + "summary": "Get proxies", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-proxies" + ], + "name": "post-fleet-proxies", + "summary": "Create a proxy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "certificate", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "certificate-authorities", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "certificate-key", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-preconfigured", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "proxy-headers", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "url", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-proxies" + ], + "name": "delete-fleet-proxies-itemid", + "summary": "Delete a proxy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The itemId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-proxies" + ], + "name": "get-fleet-proxies-itemid", + "summary": "Get a proxy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The itemId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-proxies" + ], + "name": "put-fleet-proxies-itemid", + "summary": "Update a proxy", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The itemId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "certificate", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "certificate-authorities", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "certificate-key", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "proxy-headers", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "url", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-server-hosts", + "summary": "Kibana fleet-server-hosts API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-server-hosts" + ], + "name": "get-fleet-fleet-server-hosts", + "summary": "Get Fleet Server hosts", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-server-hosts" + ], + "name": "post-fleet-fleet-server-hosts", + "summary": "Create a Fleet Server host", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "host-urls", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-default", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-internal", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-preconfigured", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "proxy-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "secrets", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ssl", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-server-hosts" + ], + "name": "delete-fleet-fleet-server-hosts-itemid", + "summary": "Delete a Fleet Server host", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The itemId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-server-hosts" + ], + "name": "get-fleet-fleet-server-hosts-itemid", + "summary": "Get a Fleet Server host", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The itemId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-server-hosts" + ], + "name": "put-fleet-fleet-server-hosts-itemid", + "summary": "Update a Fleet Server host", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The itemId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "host-urls", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-default", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-internal", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "proxy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "secrets", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ssl", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "fleet-uninstall-tokens", + "summary": "Kibana fleet-uninstall-tokens API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "fleet-uninstall-tokens" + ], + "name": "get-fleet-uninstall-tokens", + "summary": "Get metadata for latest uninstall tokens", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "policy-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Partial match filtering for policy IDs", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of items to return", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "fleet-uninstall-tokens" + ], + "name": "get-fleet-uninstall-tokens-uninstalltokenid", + "summary": "Get a decrypted uninstall token", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "uninstall-token-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The uninstallTokenId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "maintenance-window", + "summary": "Kibana maintenance-window API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "maintenance-window" + ], + "name": "post-maintenance-window", + "summary": "Create a maintenance window.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "schedule", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scope", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "title", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "maintenance-window" + ], + "name": "get-maintenance-window-find", + "summary": "Search for a maintenance window.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "title", + "shortName": null, + "type": "string", + "required": false, + "summary": "The title of the maintenance window.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "created-by", + "shortName": null, + "type": "string", + "required": false, + "summary": "The user who created the maintenance window.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "status", + "shortName": null, + "type": "string", + "required": false, + "summary": "The status of the maintenance window. It can be \"running\", \"upcoming\", \"finished\", \"archived\", or \"disabled\".", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of maintenance windows to return per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "maintenance-window" + ], + "name": "delete-maintenance-window-id", + "summary": "Delete a maintenance window.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the maintenance window to be deleted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "maintenance-window" + ], + "name": "get-maintenance-window-id", + "summary": "Get maintenance window details.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the maintenance window.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "maintenance-window" + ], + "name": "patch-maintenance-window-id", + "summary": "Update a maintenance window.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "schedule", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scope", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "title", + "shortName": null, + "type": "string", + "required": false, + "summary": "The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "maintenance-window" + ], + "name": "post-maintenance-window-id-archive", + "summary": "Archive a maintenance window.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the maintenance window to be archived.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "maintenance-window" + ], + "name": "post-maintenance-window-id-unarchive", + "summary": "Unarchive a maintenance window.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the maintenance window to be unarchived.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "message-signing-service", + "summary": "Kibana message-signing-service API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "message-signing-service" + ], + "name": "post-fleet-message-signing-service-rotate-key-pair", + "summary": "Rotate a Fleet message signing key pair", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "acknowledge", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "misc", + "summary": "Kibana misc API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "misc" + ], + "name": "get-actions-connector-oauth-callback-script", + "summary": null, + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "misc" + ], + "name": "get-fleet-space-settings", + "summary": "Get space settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "misc" + ], + "name": "put-fleet-space-settings", + "summary": "Create space settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "allowed-namespace-prefixes", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "misc" + ], + "name": "post-security-role-query", + "summary": "Query roles", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "filters", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "ml", + "summary": "Kibana ml API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "ml" + ], + "name": "ml-sync", + "summary": "Sync saved objects in the default space", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "ml" + ], + "name": "ml-update-jobs-spaces", + "summary": "Update jobs spaces", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "ml" + ], + "name": "ml-update-trained-models-spaces", + "summary": "Update trained models spaces", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "observabilityaiassistant", + "summary": "Kibana observabilityaiassistant API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "observabilityaiassistant" + ], + "name": "observability-ai-assistant-chat-complete", + "summary": "Generate a chat completion", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "actions", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A unique identifier for the connector.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A unique identifier for the conversation if you are continuing an existing conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "disable-functions", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Flag indicating whether all function calls should be disabled for the conversation. If true, no calls to functions will be made.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "instructions", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of instruction objects, which can be either simple strings or detailed objects.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "messages", + "shortName": null, + "type": "array", + "required": true, + "summary": "An array of message objects containing the conversation history.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "persist", + "shortName": null, + "type": "boolean", + "required": true, + "summary": "Indicates whether the conversation should be saved to storage. If true, the conversation will be saved and will be available in Kibana.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "title", + "shortName": null, + "type": "string", + "required": false, + "summary": "A title for the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "roles", + "summary": "Kibana roles API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "roles" + ], + "name": "get-security-role", + "summary": "Get all roles", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "replace-deprecated-privileges", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true` and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "roles" + ], + "name": "delete-security-role-name", + "summary": "Delete a role", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "roles" + ], + "name": "get-security-role-name", + "summary": "Get a role", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The role name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "replace-deprecated-privileges", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true` and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "roles" + ], + "name": "put-security-role-name", + "summary": "Create or update a role", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The role name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "create-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, a role is not overwritten if it already exists.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description for the role.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "elasticsearch", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kibana", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "roles" + ], + "name": "post-security-roles", + "summary": "Create or update roles", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "roles", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "saved-objects", + "summary": "Kibana saved-objects API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "saved-objects" + ], + "name": "post-saved-objects-export", + "summary": "Export saved objects", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "exclude-export-details", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Do not add export details entry at the end of the stream.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "has-reference", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-references-deep", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Includes all of the referenced objects in the exported objects.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "objects", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of objects to export. NOTE: this optional parameter cannot be combined with the `types` option", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search for documents to export using the Elasticsearch Simple Query String syntax.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The saved object types to include in the export. Use `*` to export all the types. Valid options depend on enabled plugins, but may include `visualization`, `dashboard`, `search`, `index-pattern`, `tag`, `config`, `config-global`, `lens`, `map`, `event-annotation-group`, `query`, `url`, `action`, `alert`, `alerting_rule_template`, `apm-indices`, `cases-user-actions`, `cases`, `cases-comments`, `infrastructure-monitoring-log-view`, `ml-trained-model`, `osquery-saved-query`, `osquery-pack`, `osquery-pack-asset`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "saved-objects" + ], + "name": "post-saved-objects-import", + "summary": "Import saved objects", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "overwrite", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Overwrites saved objects when they already exist. When used, potential conflict errors are automatically resolved by overwriting the destination object. NOTE: This option cannot be used with the `createNewCopies` option.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "create-new-copies", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Creates copies of saved objects, regenerates each object ID, and resets the origin. When used, potential conflict errors are avoided. NOTE: This option cannot be used with the `overwrite` and `compatibilityMode` options.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "compatibility-mode", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Applies various adjustments to the saved objects that are being imported to maintain compatibility between different Kibana versions. Use this option only if you encounter issues with imported saved objects. NOTE: This option cannot be used with the `createNewCopies` option.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-ai-assistant-api", + "summary": "Kibana security-ai-assistant-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "perform-anonymization-fields-bulk-action", + "summary": "Apply a bulk action to anonymization fields", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "create", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of anonymization fields to create.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete", + "shortName": null, + "type": "object", + "required": false, + "summary": "Object containing the query to filter anonymization fields and/or an array of anonymization field IDs to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "update", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of anonymization fields to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "find-anonymization-fields", + "summary": "Get anonymization fields", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "Fields to return", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search query", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field to sort by", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort order", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "AnonymizationFields per page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "all-data", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, additionally fetch all anonymization fields, otherwise fetch only the provided page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "chat-complete", + "summary": "Create a model response", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "content-references-disabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the response will not include content references.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Required connector identifier to route the request.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "conversation-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A string that does not contain only whitespace characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-stream", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, the response will be streamed in chunks.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lang-smith-api-key", + "shortName": null, + "type": "string", + "required": false, + "summary": "API key for LangSmith integration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lang-smith-project", + "shortName": null, + "type": "string", + "required": false, + "summary": "LangSmith project name for tracing.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "messages", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of chat messages exchanged so far.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model", + "shortName": null, + "type": "string", + "required": false, + "summary": "Model ID or name to use for the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "persist", + "shortName": null, + "type": "boolean", + "required": true, + "summary": "Whether to persist the chat and response to storage.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "prompt-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Prompt template identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "response-language", + "shortName": null, + "type": "string", + "required": false, + "summary": "ISO language code for the assistant's response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "delete-all-conversations", + "summary": "Delete conversations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "excluded-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "Optional list of conversation IDs to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "create-conversation", + "summary": "Create a conversation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "api-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "category", + "shortName": null, + "type": "string", + "required": false, + "summary": "The conversation category.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-from-last-conversation-storage", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Exclude from last conversation storage.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The conversation id.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "messages", + "shortName": null, + "type": "array", + "required": false, + "summary": "The conversation messages.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "replacements", + "shortName": null, + "type": "object", + "required": false, + "summary": "Replacements object used to anonymize/deanonymize messages", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "title", + "shortName": null, + "type": "string", + "required": true, + "summary": "The conversation title.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "find-conversations", + "summary": "Get conversations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "A list of fields to include in the response. If omitted, all fields are returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "A search query to filter the conversations. Can match against titles, messages, or other conversation attributes.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field by which to sort the results. Valid fields are `created_at`, `title`, and `updated_at`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "The order in which to sort the results. Can be either `asc` for ascending or `desc` for descending.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number of the results to retrieve. Default is 1.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of conversations to return per page. Default is 20.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-owner", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to return conversations that the current user owns. If true, only conversations owned by the user are returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "delete-conversation", + "summary": "Delete a conversation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The conversation's `id` value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "read-conversation", + "summary": "Get a conversation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The conversation's `id` value, a unique identifier for the conversation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "update-conversation", + "summary": "Update a conversation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The conversation's `id` value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "api-config", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "category", + "shortName": null, + "type": "string", + "required": false, + "summary": "The conversation category.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-from-last-conversation-storage", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Exclude from last conversation storage.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "body-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "A string that does not contain only whitespace characters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "messages", + "shortName": null, + "type": "array", + "required": false, + "summary": "The conversation messages.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "replacements", + "shortName": null, + "type": "object", + "required": false, + "summary": "Replacements object used to anonymize/deanonymize messages", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "title", + "shortName": null, + "type": "string", + "required": false, + "summary": "The conversation title.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "users", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "get-knowledge-base", + "summary": "Read a KnowledgeBase", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "post-knowledge-base", + "summary": "Create a KnowledgeBase", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "ELSER modelId to use when setting up the Knowledge Base. If not provided, a default model will be used.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-security-labs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether we should or should not install Security Labs docs when setting up the Knowledge Base. Defaults to `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "read-knowledge-base", + "summary": "Read a KnowledgeBase for a resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "resource", + "shortName": null, + "type": "string", + "required": true, + "summary": "The KnowledgeBase `resource` value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "create-knowledge-base", + "summary": "Create a KnowledgeBase for a resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "resource", + "shortName": null, + "type": "string", + "required": true, + "summary": "The KnowledgeBase `resource` value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "ELSER modelId to use when setting up the Knowledge Base. If not provided, a default model will be used.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-security-labs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether we should or should not install Security Labs docs when setting up the Knowledge Base. Defaults to `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "create-knowledge-base-entry", + "summary": "Create a Knowledge Base Entry", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "perform-knowledge-base-entry-bulk-action", + "summary": "Applies a bulk action to multiple Knowledge Base Entries", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "create", + "shortName": null, + "type": "array", + "required": false, + "summary": "List of Knowledge Base Entries to create.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "update", + "shortName": null, + "type": "array", + "required": false, + "summary": "List of Knowledge Base Entries to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "find-knowledge-base-entries", + "summary": "Finds Knowledge Base Entries that match the given query.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "A list of fields to include in the response. If not provided, all fields will be included.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search query to filter Knowledge Base Entries by specific criteria.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field to sort the Knowledge Base Entries by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort order for the results, either asc or desc.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number for paginated results. Defaults to 1.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of Knowledge Base Entries to return per page. Defaults to 20.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "delete-knowledge-base-entry", + "summary": "Deletes a single Knowledge Base Entry using the `id` field", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier (`id`) of the Knowledge Base Entry to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "read-knowledge-base-entry", + "summary": "Read a Knowledge Base Entry", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier (`id`) of the Knowledge Base Entry to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "update-knowledge-base-entry", + "summary": "Update a Knowledge Base Entry", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier (`id`) of the Knowledge Base Entry to update.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "perform-prompts-bulk-action", + "summary": "Apply a bulk action to prompts", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "create", + "shortName": null, + "type": "array", + "required": false, + "summary": "List of prompts to be created.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete", + "shortName": null, + "type": "object", + "required": false, + "summary": "Criteria for deleting prompts in bulk.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "update", + "shortName": null, + "type": "array", + "required": false, + "summary": "List of prompts to be updated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-ai-assistant-api" + ], + "name": "find-prompts", + "summary": "Get prompts", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of specific fields to include in each returned prompt.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search query string to filter prompts by matching fields.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field to sort prompts by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort order, either asc or desc.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number for pagination.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of prompts per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-attack-discovery-api", + "summary": "Kibana security-attack-discovery-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "post-attack-discovery-bulk", + "summary": "Bulk update Attack discoveries", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "update", + "shortName": null, + "type": "object", + "required": true, + "summary": "Configuration object containing all parameters for the bulk update operation", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "attack-discovery-find", + "summary": "Find Attack discoveries that match the search criteria", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter results to Attack discoveries that include any of the provided alert IDs", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-names", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter results to Attack discoveries created by any of the provided human readable connector names. Note that values must match the human readable `connector_name` property of an Attack discovery, e.g. \"GPT-5 Chat\", which are distinct from `connector_id` values used to generate Attack discoveries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enable-field-rendering", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Enables a markdown syntax used to render pivot fields, for example `{{ user.name james }}`. When disabled, the same example would be rendered as `james`. This is primarily used for Attack discovery views within Kibana. Defaults to `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "End of the time range for the search. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now\", \"now-24h\").", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter results to the Attack discoveries with the specified IDs", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-unique-alert-ids", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If `true`, the response will include `unique_alert_ids` and `unique_alert_ids_count` aggregated across the matched Attack discoveries", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number to return (used for pagination). Defaults to 1.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of Attack discoveries to return per page (used for pagination). Defaults to 10.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "Free-text search query applied to relevant text fields of Attack discoveries (title, description, tags, etc.)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "shared", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to filter by shared visibility. If omitted, both shared and privately visible Attack discoveries are returned. Use `true` to return only shared discoveries, `false` to return only those visible to the current user.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "scheduled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to filter by scheduled or ad-hoc attack discoveries. If omitted, both types of attack discoveries are returned. Use `true` to return only scheduled discoveries or `false` to return only ad-hoc discoveries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field used to sort results. See `AttackDiscoveryFindSortField` for allowed values.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort order direction `asc` for ascending or `desc` for descending. Defaults to `desc`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "Start of the time range for the search. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now-7d\").", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "status", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by alert workflow status. Provide one or more of the allowed workflow states.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-replacements", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, return the created Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. Defaults to `true`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "post-attack-discovery-generate", + "summary": "Generate attack discoveries from alerts", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "alerts-index-pattern", + "shortName": null, + "type": "string", + "required": true, + "summary": "The (space specific) index pattern that contains the alerts to use as", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "anonymization-fields", + "shortName": null, + "type": "array", + "required": true, + "summary": "The list of fields, and whether or not they are anonymized, allowed to be sent to LLMs. Consider using the output of the `/api/security_ai_assistant/anonymization_fields/_find` API (for a specific Kibana space) to provide this value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "api-config", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "object", + "required": false, + "summary": "An Elasticsearch-style query DSL object used to filter alerts. For example:", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "model", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "replacements", + "shortName": null, + "type": "object", + "required": false, + "summary": "Replacements object used to anonymize/deanonymize messages", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sub-action", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "get-attack-discovery-generations", + "summary": "Get the latest attack discovery generations metadata for the current user", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "end", + "shortName": null, + "type": "string", + "required": false, + "summary": "End of the time range for filtering generations. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now\", \"now-24h\").", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The maximum number of generations to retrieve", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start", + "shortName": null, + "type": "string", + "required": false, + "summary": "Start of the time range for filtering generations. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now-7d\").", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "get-attack-discovery-generation", + "summary": "Get a single Attack discovery generation, including its discoveries and (optional) generation metadata", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-uuid", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier for the Attack discovery generation execution. This UUID is returned at the start of an Attack discovery generation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enable-field-rendering", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Enables a markdown syntax used to render pivot fields, for example `{{ user.name james }}`. When disabled, the same example would be rendered as `james`. This is primarily used for Attack discovery views within Kibana. Defaults to `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-replacements", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, return the created Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. Defaults to `true`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "post-attack-discovery-generations-dismiss", + "summary": "Dismiss an attack discovery generation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-uuid", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier for the Attack discovery generation execution. This UUID is returned when an attack discovery generation is created and can be found in generation responses.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "create-attack-discovery-schedules", + "summary": "Create Attack discovery schedule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "actions", + "shortName": null, + "type": "array", + "required": false, + "summary": "The attack discovery schedule actions", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether the schedule is enabled", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the schedule", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "object", + "required": true, + "summary": "An attack discovery schedule params", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "schedule", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "find-attack-discovery-schedules", + "summary": "Finds Attack discovery schedules that match the search criteria", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number to return (used for pagination). Defaults to 1.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of Attack discovery schedules to return per page (used for pagination). Defaults to 10.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field used to sort results. Common fields include 'name', 'created_at', 'updated_at', and 'enabled'.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-direction", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort order direction. Use 'asc' for ascending or 'desc' for descending. Defaults to 'asc'.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "delete-attack-discovery-schedules", + "summary": "Delete Attack discovery schedule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier (UUID) of the Attack Discovery schedule to delete. This ID is returned when creating a schedule and can be found in schedule listings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "get-attack-discovery-schedules", + "summary": "Get Attack discovery schedule by ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier (UUID) of the Attack Discovery schedule to retrieve. This ID is returned when creating a schedule and can be found in schedule listings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "update-attack-discovery-schedules", + "summary": "Update Attack discovery schedule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier (UUID) of the Attack Discovery schedule to update. This ID is returned when creating a schedule and can be found in schedule listings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "actions", + "shortName": null, + "type": "array", + "required": true, + "summary": "The attack discovery schedule actions", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the schedule", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "params", + "shortName": null, + "type": "object", + "required": true, + "summary": "An attack discovery schedule params", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "schedule", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "disable-attack-discovery-schedules", + "summary": "Disable Attack discovery schedule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier (UUID) of the Attack Discovery schedule to disable. This ID is returned when creating a schedule and can be found in schedule listings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-attack-discovery-api" + ], + "name": "enable-attack-discovery-schedules", + "summary": "Enable Attack discovery schedule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The unique identifier (UUID) of the Attack Discovery schedule to enable. This ID is returned when creating a schedule and can be found in schedule listings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-detections-api", + "summary": "Kibana security-detections-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "read-privileges", + "summary": "Returns user privileges for the Kibana space", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "delete-rule", + "summary": "Delete a detection rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The rule's `id` value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The rule's `rule_id` value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "read-rule", + "summary": "Retrieve a detection rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The rule's `id` value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "rule-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The rule's `rule_id` value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "patch-rule", + "summary": "Patch a detection rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "create-rule", + "summary": "Create a detection rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "update-rule", + "summary": "Update a detection rule", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "perform-rules-bulk-action", + "summary": "Apply a bulk action to detection rules", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kb-dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Enables dry run mode for the request call.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "export-rules", + "summary": "Export detection rules", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "exclude-export-details", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether a summary of the exported rules is returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "file-name", + "shortName": null, + "type": "string", + "required": false, + "summary": "File name for saving the exported rules.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "objects", + "shortName": null, + "type": "array", + "required": true, + "summary": "Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "find-rules", + "summary": "List all detection rules", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search query", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field to sort by", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort order", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Rules per page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "gaps-range-start", + "shortName": null, + "type": "string", + "required": false, + "summary": "Gaps range start", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "gaps-range-end", + "shortName": null, + "type": "string", + "required": false, + "summary": "Gaps range end", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "gap-fill-statuses", + "shortName": null, + "type": "string", + "required": false, + "summary": "Gap fill statuses", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "gap-auto-fill-scheduler-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Gap auto fill scheduler ID used to determine gap fill status for rules", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "import-rules", + "summary": "Import detection rules", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "overwrite", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether existing rules with the same `rule_id` are overwritten.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "overwrite-exceptions", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether existing exception lists with the same `list_id` are overwritten. Both the exception list container and its items are overwritten.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "overwrite-action-connectors", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether existing actions with the same `kibana.alert.rule.actions.id` are overwritten.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "as-new-list", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Generates a new list ID for each imported exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "rule-preview", + "summary": "Preview rule alerts generated on specified time range", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "enable-logged-requests", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Enables logging and returning in response ES queries, performed during rule execution", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "set-alert-assignees", + "summary": "Assign and unassign users from detection alerts", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "assignees", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "A list of alerts `id`s.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "search-alerts", + "summary": "Find and/or aggregate detection alerts", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "aggs", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "runtime-mappings", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "track-total-hits", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "set-alerts-status", + "summary": "Set a detection alert status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "set-alert-tags", + "summary": "Add and remove detection alert tags", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "A list of alerts `id`s.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "object", + "required": true, + "summary": "Object with list of tags to add and remove.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-detections-api" + ], + "name": "read-tags", + "summary": "List all detection rule tags", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-endpoint-exceptions-api", + "summary": "Kibana security-endpoint-exceptions-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-endpoint-exceptions-api" + ], + "name": "create-endpoint-list", + "summary": "Create an Elastic Endpoint rule exception list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-exceptions-api" + ], + "name": "delete-endpoint-list-item", + "summary": "Delete an Elastic Endpoint exception list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Either `id` or `item_id` must be specified", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Either `id` or `item_id` must be specified", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-exceptions-api" + ], + "name": "read-endpoint-list-item", + "summary": "Get an Elastic Endpoint rule exception list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Either `id` or `item_id` must be specified", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Either `id` or `item_id` must be specified", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-exceptions-api" + ], + "name": "create-endpoint-list-item", + "summary": "Create an Elastic Endpoint rule exception list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "comments", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of comment fields:", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Describes the exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "entries", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Human readable string identifier, e.g. `trusted-linux-processes`", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Exception list name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "os-types", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-exceptions-api" + ], + "name": "update-endpoint-list-item", + "summary": "Update an Elastic Endpoint rule exception list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comments", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of comment fields:", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Describes the exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "entries", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Exception's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Human readable string identifier, e.g. `trusted-linux-processes`", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Exception list name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "os-types", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-exceptions-api" + ], + "name": "find-endpoint-list-items", + "summary": "Get Elastic Endpoint exception list items", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the returned results according to the value of the specified field,", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of exception list items to return per page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines which field is used to sort the results", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines the sort order, which can be `desc` or `asc`", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-endpoint-management-api", + "summary": "Kibana security-endpoint-management-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-get-actions-list", + "summary": "Get response actions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "commands", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "user-ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "start-date", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "end-date", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-types", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "with-outputs", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "types", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-get-actions-status", + "summary": "Get response actions status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-get-actions-details", + "summary": "Get action details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "action-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The action_id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-file-info", + "summary": "Get file information", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "action-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The action_id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "file-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The file identifier is constructed in one of two ways:", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-file-download", + "summary": "Download a file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "action-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The action_id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "file-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The file identifier is constructed in one of two ways:", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "cancel-action", + "summary": "Cancel a response action", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-execute-action", + "summary": "Run a command", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-get-file-action", + "summary": "Get a file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-isolate-action", + "summary": "Isolate an endpoint", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional parameters object", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-kill-process-action", + "summary": "Terminate a process", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-generate-memory-dump", + "summary": "Generate a memory dump from the host machine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-get-processes-action", + "summary": "Get running processes", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional parameters object", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "run-script-action", + "summary": "Run a script", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "string", + "required": true, + "summary": "One of the following set of parameters must be provided", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-scan-action", + "summary": "Scan a file or directory", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-get-actions-state", + "summary": "Get actions state", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-suspend-process-action", + "summary": "Suspend a process", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-unisolate-action", + "summary": "Release an isolated endpoint", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "comment", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional comment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "endpoint-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "parameters", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional parameters object", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-upload-action", + "summary": "Upload a file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "get-endpoint-metadata-list", + "summary": "Get a metadata list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "host-statuses", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-direction", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "get-endpoint-metadata", + "summary": "Get metadata", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "get-policy-response", + "summary": "Get a policy response", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "get-protection-updates-note", + "summary": "Get a protection updates note", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "package-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The package_policy_id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "create-update-protection-updates-note", + "summary": "Create or update a protection updates note", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "package-policy-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The package_policy_id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "note", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-entity-analytics-api", + "summary": "Kibana security-entity-analytics-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "delete-asset-criticality-record", + "summary": "Delete an asset criticality record", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id-value", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID value of the asset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id-field", + "shortName": null, + "type": "string", + "required": true, + "summary": "The field representing the ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "string", + "required": false, + "summary": "If 'wait_for' the request will wait for the index refresh.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "get-asset-criticality-record", + "summary": "Get an asset criticality record", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id-value", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID value of the asset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id-field", + "shortName": null, + "type": "string", + "required": true, + "summary": "The field representing the ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "create-asset-criticality-record", + "summary": "Upsert an asset criticality record", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "string", + "required": false, + "summary": "If 'wait_for' the request will wait for the index refresh.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "bulk-upsert-asset-criticality-records", + "summary": "Bulk upsert asset criticality records", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "records", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "find-asset-criticality-records", + "summary": "List asset criticality records", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to sort by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-direction", + "shortName": null, + "type": "string", + "required": false, + "summary": "The order to sort by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of records to return per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "The kuery to filter by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "delete-monitoring-engine", + "summary": "Delete the Privilege Monitoring Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "data", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to delete all the privileged user data", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "disable-monitoring-engine", + "summary": "Disable the Privilege Monitoring Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "init-monitoring-engine", + "summary": "Initialize the Privilege Monitoring Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "schedule-monitoring-engine", + "summary": "Schedule the Privilege Monitoring Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "priv-mon-health", + "summary": "Health check on Privilege Monitoring", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "priv-mon-privileges", + "summary": "Run a privileges check on Privilege Monitoring", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "create-priv-mon-user", + "summary": "Create a new monitored user", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-analytics-monitoring", + "shortName": null, + "type": "object", + "required": false, + "summary": "Entity analytics monitoring configuration for the user", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "user", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "privmon-bulk-upload-users-c-s-v", + "summary": "Upsert multiple monitored users via CSV upload", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "delete-priv-mon-user", + "summary": "Delete a monitored user", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "update-priv-mon-user", + "summary": "Update a monitored user", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "entity-analytics-monitoring", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "body-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "labels", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "user", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "list-priv-mon-users", + "summary": "List all monitored users", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kql", + "shortName": null, + "type": "string", + "required": false, + "summary": "KQL query to filter the list of monitored users", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "install-privileged-access-detection-package", + "summary": "Installs the privileged access detection package for the Entity Analytics privileged user monitoring experience", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "get-privileged-access-detection-package-status", + "summary": "Gets the status of the privileged access detection package for the Entity Analytics privileged user monitoring experience", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "create-watchlist", + "summary": "Create a new watchlist", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Description of the watchlist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "entity-sources", + "shortName": null, + "type": "array", + "required": false, + "summary": "Optional entity sources to create and link to the watchlist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "managed", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if the watchlist is managed by the system", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Unique name for the watchlist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "risk-modifier", + "shortName": null, + "type": "number", + "required": true, + "summary": "Risk score modifier associated with the watchlist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "get-watchlist", + "summary": "Get a watchlist by ID", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Unique ID of the watchlist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "update-watchlist", + "summary": "Update an existing watchlist", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the watchlist to update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Description of the watchlist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "managed", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if the watchlist is managed by the system", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Unique name of the watchlist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "risk-modifier", + "shortName": null, + "type": "number", + "required": true, + "summary": "Risk score modifier associated with the watchlist", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "list-watchlists", + "summary": "List all watchlists", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "init-entity-store", + "summary": "Initialize the Entity Store", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "delay", + "shortName": null, + "type": "string", + "required": false, + "summary": "The delay before the transform will run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "docs-per-second", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of documents per second to process.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enrich-policy-execution-interval", + "shortName": null, + "type": "string", + "required": false, + "summary": "Interval in which enrich policy runs. For example, `\"1h\"` means the rule runs every hour. Must be less than or equal to half the duration of the lookback period,", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "entity-types", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-history-length", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of historical values to keep for each field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "frequency", + "shortName": null, + "type": "string", + "required": false, + "summary": "The frequency at which the transform will run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-pattern", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lookback-period", + "shortName": null, + "type": "string", + "required": false, + "summary": "The amount of time the transform looks back to calculate the aggregations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-page-search-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The initial page size to use for the composite aggregation of each checkpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The timeout for initializing the aggregating transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timestamp-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use as the timestamp.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "delete-entity-engines", + "summary": "Delete Entity Engines", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-types", + "shortName": null, + "type": "string", + "required": false, + "summary": "The entity type of the engine ('user', 'host', 'service', 'generic').", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete-data", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Control flag to also delete the entity data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "list-entity-engines", + "summary": "List the Entity Engines", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "delete-entity-engine", + "summary": "Delete the Entity Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The entity type of the engine (either 'user' or 'host').", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete-data", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Control flag to also delete the entity data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "data", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Control flag to also delete the entity data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "get-entity-engine", + "summary": "Get an Entity Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The entity type of the engine (either 'user' or 'host').", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "init-entity-engine", + "summary": "Initialize an Entity Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The entity type of the engine.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delay", + "shortName": null, + "type": "string", + "required": false, + "summary": "The delay before the transform will run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "docs-per-second", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of documents per second to process.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enrich-policy-execution-interval", + "shortName": null, + "type": "string", + "required": false, + "summary": "Interval in which enrich policy runs. For example, `\"1h\"` means the rule runs every hour. Must be less than or equal to half the duration of the lookback period,", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-history-length", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of historical values to keep for each field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "frequency", + "shortName": null, + "type": "string", + "required": false, + "summary": "The frequency at which the transform will run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "index-pattern", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "lookback-period", + "shortName": null, + "type": "string", + "required": false, + "summary": "The amount of time the transform looks back to calculate the aggregations.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "max-page-search-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The initial page size to use for the composite aggregation of each checkpoint.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeout", + "shortName": null, + "type": "string", + "required": false, + "summary": "The timeout for initializing the aggregating transform.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timestamp-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "The field to use as the timestamp for the entity type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "start-entity-engine", + "summary": "Start an Entity Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The entity type of the engine", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "stop-entity-engine", + "summary": "Stop an Entity Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The entity type of the engine (either 'user' or 'host').", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "apply-entity-engine-dataview-indices", + "summary": "Apply DataView indices to all installed engines", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "delete-single-entity", + "summary": "Delete an entity in Entity Store", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The entityType parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier of the entity to be deleted, commonly entity.id value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "upsert-entity", + "summary": "Upsert an entity in Entity Store", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "entity-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The entityType parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "upsert-entities-bulk", + "summary": "Upsert many entities in Entity Store", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "entities", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "list-entities", + "summary": "List Entity Store Entities", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter-query", + "shortName": null, + "type": "string", + "required": false, + "summary": "An ES query to filter by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "entity-types", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "get-entity-store-status", + "summary": "Get the status of the Entity Store", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "include-components", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true returns a detailed status of the engine including all it's components", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "clean-up-risk-engine", + "summary": "Cleanup the Risk Engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "configure-risk-engine-saved-object", + "summary": "Configure the Risk Engine Saved Object", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "enable-reset-to-zero", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-alert-statuses", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "exclude-alert-tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filters", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "range", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-entity-analytics-api" + ], + "name": "schedule-risk-engine-now", + "summary": "Run the risk scoring engine", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-exceptions-api", + "summary": "Kibana security-exceptions-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "create-rule-exception-list-items", + "summary": "Create rule exception items", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Detection rule's identifier", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "items", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "delete-exception-list", + "summary": "Delete an exception list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Exception list's identifier. Either `id` or `list_id` must be specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Human readable exception list string identifier, e.g. `trusted-linux-processes`. Either `id` or `list_id` must be specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "read-exception-list", + "summary": "Get exception list details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Exception list's identifier. Either `id` or `list_id` must be specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Human readable exception list string identifier, e.g. `trusted-linux-processes`. Either `id` or `list_id` must be specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "create-exception-list", + "summary": "Create an exception list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Describes the exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The exception list's human-readable string identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Placeholder for metadata about the list container.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines whether the exception container is available in all Kibana spaces or just the space", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "os-types", + "shortName": null, + "type": "array", + "required": false, + "summary": "Use this field to specify the operating system. Only enter one value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "String array containing words and phrases to help categorize exception containers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of exception list to be created. Different list types may denote where they can be utilized.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "number", + "required": false, + "summary": "The document version, automatically increasd on updates.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "update-exception-list", + "summary": "Update an exception list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version id, normally returned by the API when the item was retrieved. Use it ensure updates are done against the latest version.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Describes the exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Exception list's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The exception list's human-readable string identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Placeholder for metadata about the list container.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines whether the exception container is available in all Kibana spaces or just the space", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "os-types", + "shortName": null, + "type": "array", + "required": false, + "summary": "Use this field to specify the operating system. Only enter one value.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "String array containing words and phrases to help categorize exception containers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of exception list to be created. Different list types may denote where they can be utilized.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "number", + "required": false, + "summary": "The document version, automatically increasd on updates.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "duplicate-exception-list", + "summary": "Duplicate an exception list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-expired-exceptions", + "shortName": null, + "type": "string", + "required": true, + "summary": "Determines whether to include expired exceptions in the duplicated list. Expiration date defined by `expire_time`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "export-exception-list", + "summary": "Export an exception list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-expired-exceptions", + "shortName": null, + "type": "string", + "required": true, + "summary": "Determines whether to include expired exceptions in the exported list. Expiration date defined by `expire_time`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "find-exception-lists", + "summary": "Get exception lists", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the returned results according to the value of the specified field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines whether the returned containers are Kibana associated with a Kibana space", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of exception lists to return per page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines which field is used to sort the results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines the sort order, which can be `desc` or `asc`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "import-exception-list", + "summary": "Import an exception list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "overwrite", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether existing exception lists with the same `list_id` are overwritten.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "as-new-list", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether the list being imported will have a new `list_id` generated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "delete-exception-list-item", + "summary": "Delete an exception list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Exception item's identifier. Either `id` or `item_id` must be specified", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Human readable exception item string identifier, e.g. `trusted-linux-processes`. Either `id` or `item_id` must be specified", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "read-exception-list-item", + "summary": "Get an exception list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Exception list item's identifier. Either `id` or `item_id` must be specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "item-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Human readable exception item string identifier, e.g. `trusted-linux-processes`. Either `id` or `item_id` must be specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "create-exception-list-item", + "summary": "Create an exception list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "update-exception-list-item", + "summary": "Update an exception list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "find-exception-list-items", + "summary": "Get exception list items", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The `list_id`s of the items to fetch.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the returned results according to the value of the specified field,", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines whether the returned containers are Kibana associated with a Kibana space", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of exception list items to return per page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines which field is used to sort the results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines the sort order, which can be `desc` or `asc`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "read-exception-list-summary", + "summary": "Get an exception list summary", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Exception list's identifier generated upon creation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Exception list's human readable identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "namespace-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search filter clause", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-exceptions-api" + ], + "name": "create-shared-exception-list", + "summary": "Create a shared exception list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Describes the exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the exception list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-lists-api", + "summary": "Kibana security-lists-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "delete-list", + "summary": "Delete a value list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "delete-references", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether exception items referencing this value list should be deleted.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-references", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Determines whether to delete value list without performing any additional checks of where this list may be utilized.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "read-list", + "summary": "Get value list details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "patch-list", + "summary": "Patch a value list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "Describes the value list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Value list's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Placeholder for metadata about the value list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value list's name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "number", + "required": false, + "summary": "The document version number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "create-list", + "summary": "Create a value list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Describes the value list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value list's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Placeholder for metadata about the value list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Value list's name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": true, + "summary": "Specifies the Elasticsearch data type of excludes the list container holds. Some common examples:", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "update-list", + "summary": "Update a value list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "Describes the value list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Value list's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Placeholder for metadata about the value list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "Value list's name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "number", + "required": false, + "summary": "The document version number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "find-lists", + "summary": "Get value lists", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of value lists to return per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines which field is used to sort the results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines the sort order, which can be `desc` or `asc`", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cursor", + "shortName": null, + "type": "string", + "required": false, + "summary": "Returns the lists that come after the last lists returned in the previous call (use the `cursor` value returned in the previous call). This parameter uses the `tie_breaker_id` field to ensure all lists are sorted and returned correctly.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the returned results according to the value of the specified field,", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "delete-list-index", + "summary": "Delete value list data streams", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "read-list-index", + "summary": "Get status of value list data streams", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "create-list-index", + "summary": "Create list data streams", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "delete-list-item", + "summary": "Delete a value list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value list item's identifier. Required if `list_id` and `value` are not specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value list's identifier. Required if `id` is not specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "value", + "shortName": null, + "type": "string", + "required": false, + "summary": "The value used to evaluate exceptions. Required if `id` is not specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines when changes made by the request are made visible to search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "read-list-item", + "summary": "Get a value list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value list item identifier. Required if `list_id` and `value` are not specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value list item list's `id` identfier. Required if `id` is not specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "value", + "shortName": null, + "type": "string", + "required": false, + "summary": "The value used to evaluate exceptions. Required if `id` is not specified.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "patch-list-item", + "summary": "Patch a value list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Value list item's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Placeholder for metadata about the value list item.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines when changes made by the request are made visible to search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "value", + "shortName": null, + "type": "string", + "required": false, + "summary": "The value used to evaluate exceptions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "create-list-item", + "summary": "Create a value list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Value list item's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Value list's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Placeholder for metadata about the value list item.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines when changes made by the request are made visible to search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "value", + "shortName": null, + "type": "string", + "required": true, + "summary": "The value used to evaluate exceptions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "update-list-item", + "summary": "Update a value list item", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "version", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Value list item's identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "meta", + "shortName": null, + "type": "object", + "required": false, + "summary": "Placeholder for metadata about the value list item.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "value", + "shortName": null, + "type": "string", + "required": true, + "summary": "The value used to evaluate exceptions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "export-list-items", + "summary": "Export value list items", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Value list's `id` to export.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "find-list-items", + "summary": "Get value list items", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page number to return.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The number of list items to return per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines which field is used to sort the results.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines the sort order, which can be `desc` or `asc`", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cursor", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the returned results according to the value of the specified field,", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "import-list-items", + "summary": "Import value list items", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "list-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "List's id.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "type", + "shortName": null, + "type": "string", + "required": false, + "summary": "Type of the importing list.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "refresh", + "shortName": null, + "type": "string", + "required": false, + "summary": "Determines when changes made by the request are made visible to search.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-lists-api" + ], + "name": "read-list-privileges", + "summary": "Get value list privileges", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-osquery-api", + "summary": "Kibana security-osquery-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-find-live-queries", + "summary": "Get live queries", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-create-live-query", + "summary": "Create a live query", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "agent-all", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When `true`, the query runs on all agents.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of agent IDs to run the query on.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-platforms", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of agent platforms to run the query on.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "agent-policy-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of agent policy IDs to run the query on.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alert-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of alert IDs associated with the live query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "case-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of case IDs associated with the live query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ecs-mapping", + "shortName": null, + "type": "object", + "required": false, + "summary": "Map osquery results columns or static values to Elastic Common Schema (ECS) fields", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "event-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of event IDs associated with the live query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "Custom metadata object associated with the live query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pack-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the pack you want to run, retrieve, update, or delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "queries", + "shortName": null, + "type": "array", + "required": false, + "summary": "An array of queries to run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "The SQL query you want to run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "saved-query-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of a saved query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-get-live-query-details", + "summary": "Get live query details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-get-live-query-results", + "summary": "Get live query results", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "action-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The actionId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kuery", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-find-packs", + "summary": "Get packs", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-create-packs", + "summary": "Create a pack", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "The pack description.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Enables the pack.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The pack name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "policy-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of agents policy IDs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "queries", + "shortName": null, + "type": "object", + "required": false, + "summary": "An object of queries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "shards", + "shortName": null, + "type": "object", + "required": false, + "summary": "An object with shard configuration for policies included in the pack. For each policy, set the shard configuration to a percentage (1–100) of target hosts.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-delete-packs", + "summary": "Delete a pack", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-get-packs-details", + "summary": "Get pack details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-update-packs", + "summary": "Update a pack", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "The pack description.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Enables the pack.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The pack name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "policy-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "A list of agents policy IDs.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "queries", + "shortName": null, + "type": "object", + "required": false, + "summary": "An object of queries.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "shards", + "shortName": null, + "type": "object", + "required": false, + "summary": "An object with shard configuration for policies included in the pack. For each policy, set the shard configuration to a percentage (1–100) of target hosts.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-find-saved-queries", + "summary": "Get saved queries", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-create-saved-query", + "summary": "Create a saved query", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "The saved query description.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ecs-mapping", + "shortName": null, + "type": "object", + "required": false, + "summary": "Map osquery results columns or static values to Elastic Common Schema (ECS) fields", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of a saved query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "interval", + "shortName": null, + "type": "string", + "required": false, + "summary": "An interval, in seconds, on which to run the query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "platform", + "shortName": null, + "type": "string", + "required": false, + "summary": "Restricts the query to a specified platform. The default is all platforms. To specify multiple platforms, use commas. For example, `linux,darwin`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "The SQL query you want to run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "removed", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether the query is removed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether the query is a snapshot.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "Uses the Osquery versions greater than or equal to the specified version string.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-delete-saved-query", + "summary": "Delete a saved query", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-get-saved-query-details", + "summary": "Get saved query details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-osquery-api" + ], + "name": "osquery-update-saved-query", + "summary": "Update a saved query", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The id parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "The saved query description.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ecs-mapping", + "shortName": null, + "type": "object", + "required": false, + "summary": "Map osquery results columns or static values to Elastic Common Schema (ECS) fields", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "body-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of a saved query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "interval", + "shortName": null, + "type": "string", + "required": false, + "summary": "An interval, in seconds, on which to run the query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "platform", + "shortName": null, + "type": "string", + "required": false, + "summary": "Restricts the query to a specified platform. The default is all platforms. To specify multiple platforms, use commas. For example, `linux,darwin`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "The SQL query you want to run.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "removed", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether the query is removed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates whether the query is a snapshot.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "Uses the Osquery versions greater than or equal to the specified version string.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "security-timeline-api", + "summary": "Kibana security-timeline-api API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "delete-note", + "summary": "Delete a note", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "get-notes", + "summary": "Get notes", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "document-ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "saved-object-ids", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "created-by-filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "associated-filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "persist-note-route", + "summary": "Add or update a note", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "note", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "note-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The `savedObjectId` of the note", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "The version of the note", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "persist-pinned-event-route", + "summary": "Pin/unpin an event", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "event-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The `_id` of the associated event for this pinned event.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "pinned-event-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The `savedObjectId` of the pinned event you want to unpin.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The `savedObjectId` of the timeline that you want this pinned event unpinned from.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "delete-timelines", + "summary": "Delete Timelines or Timeline templates", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "saved-object-ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "The list of IDs of the Timelines or Timeline templates to delete", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "Saved search IDs that should be deleted alongside the timelines", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "get-timeline", + "summary": "Get Timeline or Timeline template details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "template-timeline-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The `savedObjectId` of the template timeline to retrieve", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The `savedObjectId` of the Timeline to retrieve.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "patch-timeline", + "summary": "Update a Timeline", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "timeline", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The `savedObjectId` of the Timeline or Timeline template that you’re updating.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The version of the Timeline or Timeline template that you’re updating.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "create-timelines", + "summary": "Create a Timeline or Timeline template", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "status", + "shortName": null, + "type": "string", + "required": false, + "summary": "The status of the Timeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "template-timeline-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A unique identifier for the Timeline template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "template-timeline-version", + "shortName": null, + "type": "number", + "required": false, + "summary": "Timeline template version number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A unique identifier for the Timeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "The type of Timeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "copy-timeline", + "summary": "Copies timeline or timeline template", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "timeline", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline-id-to-copy", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "get-draft-timelines", + "summary": "Get draft Timeline or Timeline template details", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "timeline-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "clean-draft-timelines", + "summary": "Create a clean draft Timeline or Timeline template", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "timeline-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of Timeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "export-timelines", + "summary": "Export Timelines", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "file-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the file to export", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "persist-favorite-route", + "summary": "Favorite a Timeline or Timeline template", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "template-timeline-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "template-timeline-version", + "shortName": null, + "type": "number", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of Timeline.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "import-timelines", + "summary": "Import Timelines", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "kb-file", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "is-immutable", + "shortName": null, + "type": "string", + "required": false, + "summary": "Whether the Timeline should be immutable", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "install-prepacked-timelines", + "summary": "Install prepackaged Timelines", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "prepackaged-timelines", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timelines-to-install", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timelines-to-update", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "resolve-timeline", + "summary": "Get an existing saved Timeline or Timeline template", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "template-timeline-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the template timeline to resolve", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "The ID of the timeline to resolve", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "security-timeline-api" + ], + "name": "get-timelines", + "summary": "Get Timelines or Timeline templates", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "only-user-favorite", + "shortName": null, + "type": "string", + "required": false, + "summary": "If true, only timelines that are marked as favorites by the user are returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "timeline-type", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Whether to sort the results `ascending` or `descending`", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-size", + "shortName": null, + "type": "string", + "required": false, + "summary": "How many results should returned at once", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page-index", + "shortName": null, + "type": "string", + "required": false, + "summary": "How many pages should be skipped", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "Allows to search for timelines by their title", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "status", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "slo", + "summary": "Kibana slo API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "find-slos-op", + "summary": "Get a paginated list of SLOs", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kql-query", + "shortName": null, + "type": "string", + "required": false, + "summary": "A valid kql query to filter the SLO with", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page size to use for cursor-based pagination, must be greater or equal than 1", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-after", + "shortName": null, + "type": "string", + "required": false, + "summary": "The cursor to use for fetching the results from, when using a cursor-base pagination.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page to use for pagination, must be greater or equal than 1", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of SLOs returned by page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-by", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort by field", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-direction", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort order", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "hide-stale", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "create-slo-op", + "summary": "Create an SLO", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "artifacts", + "shortName": null, + "type": "object", + "required": false, + "summary": "Links to related assets for the SLO", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "budgeting-method", + "shortName": null, + "type": "string", + "required": true, + "summary": "The budgeting method to use when computing the rollup data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "A description for the SLO.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "group-by", + "shortName": null, + "type": "string", + "required": false, + "summary": "optional group by field or fields to use to generate an SLO per distinct value", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "A optional and unique identifier for the SLO. Must be between 8 and 36 chars", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indicator", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "A name for the SLO.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "objective", + "shortName": null, + "type": "object", + "required": true, + "summary": "Defines properties for the SLO objective", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines properties for SLO settings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "List of tags", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "time-window", + "shortName": null, + "type": "object", + "required": true, + "summary": "Defines properties for the SLO time window", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "bulk-delete-op", + "summary": "Bulk delete SLO definitions and their associated summary and rollup data.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list", + "shortName": null, + "type": "array", + "required": true, + "summary": "An array of SLO Definition id", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "bulk-delete-status-op", + "summary": "Retrieve the status of the bulk deletion", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "task-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The task id of the bulk delete operation", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "delete-rollup-data-op", + "summary": "Batch delete rollup and summary data", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list", + "shortName": null, + "type": "array", + "required": true, + "summary": "An array of slo ids", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "purge-policy", + "shortName": null, + "type": "object", + "required": true, + "summary": "Policy that dictates which SLI documents to purge based on age", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "delete-slo-instances-op", + "summary": "Batch delete rollup and summary data", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "list", + "shortName": null, + "type": "array", + "required": true, + "summary": "An array of slo id and instance id", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "delete-slo-op", + "summary": "Delete an SLO", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slo-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sloId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "get-slo-op", + "summary": "Get an SLO", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slo-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sloId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "instance-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "the specific instanceId used by the summary calculation", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "update-slo-op", + "summary": "Update an SLO", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slo-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sloId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "artifacts", + "shortName": null, + "type": "object", + "required": false, + "summary": "Links to related assets for the SLO", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "budgeting-method", + "shortName": null, + "type": "string", + "required": false, + "summary": "The budgeting method to use when computing the rollup data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description for the SLO.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "group-by", + "shortName": null, + "type": "string", + "required": false, + "summary": "optional group by field or fields to use to generate an SLO per distinct value", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "indicator", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "A name for the SLO.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "objective", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines properties for the SLO objective", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "settings", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines properties for SLO settings.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "List of tags", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "time-window", + "shortName": null, + "type": "object", + "required": false, + "summary": "Defines properties for the SLO time window", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "reset-slo-op", + "summary": "Reset an SLO", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slo-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sloId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "disable-slo-op", + "summary": "Disable an SLO", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slo-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sloId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "enable-slo-op", + "summary": "Enable an SLO", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "slo-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The sloId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "slo" + ], + "name": "get-definitions-op", + "summary": "Get the SLO definitions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "space-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The spaceId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-outdated-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if the API returns only outdated SLO or all SLO definitions", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-health", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Indicates if the API returns SLO health data with definitions", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the SLOs by tag", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the SLOs by name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "The page to use for pagination, must be greater or equal than 1", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "per-page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of SLOs returned by page", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "spaces", + "summary": "Kibana spaces API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "spaces" + ], + "name": "get-spaces-space", + "summary": "Get all spaces", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "purpose", + "shortName": null, + "type": "string", + "required": false, + "summary": "Specifies which authorization checks are applied to the API call. The default value is `any`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-authorized-purposes", + "shortName": null, + "type": "string", + "required": true, + "summary": "When enabled, the API returns any spaces that the user is authorized to access in any capacity and each space will contain the purposes for which the user is authorized. This can be useful to determine which spaces a user can read but not take a specific action in. If the security plugin is not enabled, this parameter has no effect, since no authorization checks take place. This parameter cannot be used in with the `purpose` parameter.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "spaces" + ], + "name": "post-spaces-space", + "summary": "Create a space", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "reserved", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "color", + "shortName": null, + "type": "string", + "required": false, + "summary": "The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description for the space.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "disabled-features", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The space ID that is part of the Kibana URL when inside the space. Space IDs are limited to lowercase alphanumeric, underscore, and hyphen characters (a-z, 0-9, _, and -). You are cannot change the ID with the update operation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "image-url", + "shortName": null, + "type": "string", + "required": false, + "summary": "The data-URL encoded image to display in the space avatar. If specified, initials will not be displayed and the color will be visible as the background color for transparent images. For best results, your image should be 64x64. Images will not be optimized by this API call, so care should be taken when using custom images.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "initials", + "shortName": null, + "type": "string", + "required": false, + "summary": "One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The display name for the space.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "project-routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "spaces" + ], + "name": "delete-spaces-space-id", + "summary": "Delete a space", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The space identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "spaces" + ], + "name": "get-spaces-space-id", + "summary": "Get a space", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The space identifier.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "spaces" + ], + "name": "put-spaces-space-id", + "summary": "Update a space", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The space identifier. You are unable to change the ID with the update operation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "reserved", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "color", + "shortName": null, + "type": "string", + "required": false, + "summary": "The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "A description for the space.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "disabled-features", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "body-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The space ID that is part of the Kibana URL when inside the space. Space IDs are limited to lowercase alphanumeric, underscore, and hyphen characters (a-z, 0-9, _, and -). You are cannot change the ID with the update operation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "image-url", + "shortName": null, + "type": "string", + "required": false, + "summary": "The data-URL encoded image to display in the space avatar. If specified, initials will not be displayed and the color will be visible as the background color for transparent images. For best results, your image should be 64x64. Images will not be optimized by this API call, so care should be taken when using custom images.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "initials", + "shortName": null, + "type": "string", + "required": false, + "summary": "One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The display name for the space.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "project-routing", + "shortName": null, + "type": "string", + "required": false, + "summary": "Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "streams", + "summary": "Kibana streams API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "get-streams", + "summary": "Get stream list", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-disable", + "summary": "Disable streams", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-enable", + "summary": "Enable streams", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-resync", + "summary": "Resync streams", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "delete-streams-name", + "summary": "Delete a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "get-streams-name", + "summary": "Get a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "put-streams-name", + "summary": "Create or update a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-name-fork", + "summary": "Fork a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "status", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stream", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "where", + "shortName": null, + "type": "string", + "required": true, + "summary": "The root condition object. It can be a simple filter or a combination of other conditions.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "get-streams-name-ingest", + "summary": "Get ingest stream settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "put-streams-name-ingest", + "summary": "Update ingest stream settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ingest", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "get-streams-name-query", + "summary": "Get query stream settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "put-streams-name-query", + "summary": "Upsert query stream settings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "field-descriptions", + "shortName": null, + "type": "object", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-name-content-export", + "summary": "Export stream content", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "body-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-name-content-import", + "summary": "Import content into a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "get-streams-name-queries", + "summary": "Get stream queries", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-name-queries-bulk", + "summary": "Bulk update queries", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "operations", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "delete-streams-name-queries-queryid", + "summary": "Remove a query from a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The queryId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "put-streams-name-queries-queryid", + "summary": "Upsert a query to a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The queryId parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "esql", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "evidence", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "severity-score", + "shortName": null, + "type": "number", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "title", + "shortName": null, + "type": "string", + "required": true, + "summary": "A non-empty string.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "get-streams-name-significant-events", + "summary": "Read the significant events", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "bucket-size", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "Query string to filter significant events on metadata fields", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "search-mode", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search mode: keyword (BM25), semantic (vector), or hybrid (RRF). Defaults to hybrid when inference is available.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-name-significant-events-generate", + "summary": "Generate significant events", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "connector-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Optional connector ID. If not provided, the default AI connector from settings will be used.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sample-docs-size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of sample documents to use for generation from the current data of stream", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-name-significant-events-preview", + "summary": "Preview significant events", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name parameter", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "bucket-size", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "object", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "get-streams-streamname-attachments", + "summary": "Get stream attachments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "stream-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the stream", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "Search query to filter attachments by title", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-types", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by attachment types (single value or array)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by tags (single value or array)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "post-streams-streamname-attachments-bulk", + "summary": "Bulk update attachments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "stream-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the stream", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "operations", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "delete-streams-streamname-attachments-attachmenttype-attachmentid", + "summary": "Unlink an attachment from a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "stream-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the stream", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the attachment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the attachment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "streams" + ], + "name": "put-streams-streamname-attachments-attachmenttype-attachmentid", + "summary": "Link an attachment to a stream", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "stream-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the stream", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "The type of the attachment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "attachment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the attachment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "system", + "summary": "Kibana system API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "system" + ], + "name": "get-status", + "summary": "Get Kibana's current status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "v7format", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Set to \"true\" to get the response in v7 format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "v8format", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Set to \"true\" to get the response in v8 format.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "task-manager", + "summary": "Kibana task-manager API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "task-manager" + ], + "name": "task-manager-health", + "summary": "Get the task manager health", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "workflows", + "summary": "Kibana workflows API commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "delete-workflows", + "summary": "Bulk delete workflows", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, permanently deletes the workflows (hard delete) instead of soft-deleting them. The workflow IDs become available for reuse.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "Array of workflow IDs to delete.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows", + "summary": "Get workflows", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": false, + "summary": "Free-text search query.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of results per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by enabled state.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "created-by", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by creator.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by tags.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows", + "summary": "Bulk create workflows", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "overwrite", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to overwrite existing workflows.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "workflows", + "shortName": null, + "type": "array", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-aggs", + "summary": "Get workflow aggregations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "fields", + "shortName": null, + "type": "string", + "required": true, + "summary": "Fields to aggregate on.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-connectors", + "summary": "Get available connectors", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-executions-executionid", + "summary": "Get a workflow execution", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow execution ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-input", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Include execution input data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-output", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Include execution output data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-executions-executionid-cancel", + "summary": "Cancel a workflow execution", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow execution ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-executions-executionid-children", + "summary": "Get child executions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow execution ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-executions-executionid-logs", + "summary": "Get execution logs", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow execution ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "step-execution-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter logs by a specific step execution ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of log entries per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-field", + "shortName": null, + "type": "string", + "required": false, + "summary": "Field to sort by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "sort-order", + "shortName": null, + "type": "string", + "required": false, + "summary": "Sort order.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-executions-executionid-resume", + "summary": "Resume a workflow execution", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow execution ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input", + "shortName": null, + "type": "object", + "required": true, + "summary": "Input data to resume the execution with.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-executions-executionid-step-stepexecutionid", + "summary": "Get a step execution", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "execution-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow execution ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "step-execution-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Step execution ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-export", + "summary": "Export workflows", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "Array of workflow IDs to export.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-mget", + "summary": "Get workflows by IDs", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ids", + "shortName": null, + "type": "array", + "required": true, + "summary": "Array of workflow IDs to look up.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "source", + "shortName": null, + "type": "array", + "required": false, + "summary": "Array of source fields to include.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-schema", + "summary": "Get workflow JSON schema", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "loose", + "shortName": null, + "type": "boolean", + "required": true, + "summary": "When true, returns a permissive schema that allows additional properties. When false, returns a strict schema for full validation.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-stats", + "summary": "Get workflow statistics", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-step-test", + "summary": "Test a workflow step", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "context-override", + "shortName": null, + "type": "object", + "required": true, + "summary": "Context overrides for the step execution.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "execution-context", + "shortName": null, + "type": "object", + "required": false, + "summary": "Execution context for the step execution.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "step-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "ID of the step to test.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "workflow-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "ID of the workflow containing the step.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "workflow-yaml", + "shortName": null, + "type": "string", + "required": true, + "summary": "YAML definition of the workflow containing the step.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-test", + "summary": "Test a workflow", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "inputs", + "shortName": null, + "type": "object", + "required": true, + "summary": "Key-value inputs for the test execution.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "workflow-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "ID of an existing workflow to test.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "workflow-yaml", + "shortName": null, + "type": "string", + "required": false, + "summary": "YAML definition to test.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-workflow", + "summary": "Create a workflow", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "yaml", + "shortName": null, + "type": "string", + "required": true, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "delete-workflows-workflow-id", + "summary": "Delete a workflow", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, permanently deletes the workflow (hard delete) instead of soft-deleting it. The workflow ID becomes available for reuse.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-workflow-id", + "summary": "Get a workflow", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "put-workflows-workflow-id", + "summary": "Update a workflow", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "description", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enabled", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "tags", + "shortName": null, + "type": "array", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "yaml", + "shortName": null, + "type": "string", + "required": false, + "summary": "", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-workflow-id-clone", + "summary": "Clone a workflow", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "post-workflows-workflow-id-run", + "summary": "Run a workflow", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inputs", + "shortName": null, + "type": "object", + "required": true, + "summary": "Key-value inputs for the workflow execution.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "metadata", + "shortName": null, + "type": "object", + "required": false, + "summary": "Optional metadata for the execution.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-workflow-workflowid-executions", + "summary": "Get workflow executions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "workflow-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "statuses", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by execution status.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "execution-types", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by execution type.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "executed-by", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by the user who triggered the execution.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "omit-step-runs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to exclude step-level execution data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of results per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "stack", + "kb", + "workflows" + ], + "name": "get-workflows-workflow-workflowid-executions-steps", + "summary": "Get workflow step executions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "workflow-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Workflow ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "step-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter by step ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-input", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Include step input data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-output", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Include step output data.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number for pagination.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of results per page.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + } + ] + } + ] + }, + { + "segment": "cloud", + "summary": "Manage Elastic Cloud (hosted deployments and serverless projects)", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "accounts", + "summary": "Cloud accounts commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "accounts" + ], + "name": "get-current-account", + "summary": "Fetch current account information", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "accounts" + ], + "name": "update-current-account", + "summary": "Updates the current account", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "accounts" + ], + "name": "patch-current-account", + "summary": "Updates the current account", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "authentication", + "summary": "Cloud authentication commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "authentication" + ], + "name": "get-api-keys", + "summary": "Get all API keys", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "next-page", + "shortName": null, + "type": "string", + "required": false, + "summary": "Pagination cursor to get the next page of records", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "authentication" + ], + "name": "create-api-key", + "summary": "Create API key", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "authentication" + ], + "name": "delete-api-keys", + "summary": "Delete API keys", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "authentication" + ], + "name": "get-api-key", + "summary": "Get API key", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "api-key-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The API Key ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "authentication" + ], + "name": "delete-api-key", + "summary": "Delete API key", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "api-key-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The API Key ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "organizations", + "summary": "Cloud organizations commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "organizations" + ], + "name": "list-organizations", + "summary": "List organizations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "get-organization-invitation", + "summary": "Get organization invitation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "invitation-token", + "shortName": null, + "type": "string", + "required": true, + "summary": "Organization invitation token", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "accept-organization-invitation", + "summary": "Accept an organization invitation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "invitation-token", + "shortName": null, + "type": "string", + "required": true, + "summary": "Organization invitation token", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "get-organization", + "summary": "Fetch organization information", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "update-organization", + "summary": "Update organization", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "domain-claim-get-domain-claims", + "summary": "Get domain claims", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "domain-claim-delete", + "summary": "Delete domain claim", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "domain-claim-generate-verification-code", + "summary": "Generate verification code", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "domain-claim-verify-domain", + "summary": "Verify domain claim", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "get-organization-idp", + "summary": "Get organization IdP", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "setup-organization-idp", + "summary": "Setup organization IdP", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "teardown-organization-idp", + "summary": "Tear down organization IdP", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "get-organization-idp-metadata", + "summary": "Get organization service provider SAML2 metadata.xml for configuring the identity provider", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "list-organization-invitations", + "summary": "List organization invitations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "create-organization-invitations", + "summary": "Create organization invitations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "delete-organization-invitations", + "summary": "Delete organization invitations", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "invitation-tokens", + "shortName": null, + "type": "string", + "required": true, + "summary": "CSV list of Invitation tokens", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "list-organization-members", + "summary": "List organization members", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "delete-organization-memberships", + "summary": "Delete organization memberships", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "user-ids", + "shortName": null, + "type": "string", + "required": true, + "summary": "CSV list of User identifiers", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether or not to force the removal of Org memberships (effective only for Platform Admins)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "get-role-mappings", + "summary": "Get role mappings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "update-role-mappings", + "summary": "Updates role mappings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "organizations" + ], + "name": "delete-role-mappings", + "summary": "Delete role mappings", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "user-role-assignments", + "summary": "Cloud user-role-assignments commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "user-role-assignments" + ], + "name": "add-role-assignments", + "summary": "Add Role Assignments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "user-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the user; include realm name and id if required", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "user-role-assignments" + ], + "name": "remove-role-assignments", + "summary": "Remove Role Assignments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "user-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the user; include realm name and id if required", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "hosted", + "summary": "Manage Elastic Cloud Hosted deployments", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "billing-costs-analysis", + "summary": "Cloud hosted billing-costs-analysis commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "hosted", + "billing-costs-analysis" + ], + "name": "get-costs-overview", + "summary": "Get costs overview for the organization. Currently unavailable in self-hosted ECE.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "billing-costs-analysis" + ], + "name": "get-costs-charts", + "summary": "Get charts for the organization. Currently unavailable in self-hosted ECE.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "bucketing-strategy", + "shortName": null, + "type": "string", + "required": false, + "summary": "The desired bucketing strategy for the charts. Defaults to `daily`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "billing-costs-analysis" + ], + "name": "get-costs-deployments", + "summary": "Get deployments costs for the organization. Currently unavailable in self-hosted ECE.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the beginning of the desired range for which to fetch activity. Defaults to start of current month.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the end of the desired range for which to fetch activity. Defaults to the current date.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "billing-costs-analysis" + ], + "name": "get-costs-charts-by-deployment", + "summary": "Get charts by deployment. Currently unavailable in self-hosted ECE.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Id of a Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "bucketing-strategy", + "shortName": null, + "type": "string", + "required": false, + "summary": "The desired bucketing strategy for the charts. Defaults to `daily`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "billing-costs-analysis" + ], + "name": "get-costs-items-by-deployment", + "summary": "Get itemized costs by deployments. Currently unavailable in self-hosted ECE.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Id of a Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "billing-costs-analysis" + ], + "name": "get-costs-items", + "summary": "Get itemized costs for the organization. Currently unavailable in self-hosted ECE.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the organization", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "from", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "to", + "shortName": null, + "type": "string", + "required": false, + "summary": "A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "deployment-templates", + "summary": "Cloud hosted deployment-templates commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "hosted", + "deployment-templates" + ], + "name": "get-deployment-templates-v2", + "summary": "Get deployment templates", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "metadata", + "shortName": null, + "type": "string", + "required": false, + "summary": "An optional key/value pair in the form of (key:value) that will act as a filter and exclude any templates that do not have a matching metadata item associated.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-instance-configurations", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will return details for each instance configuration referenced by the template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-max-zones", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stack-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "If present, it will cause the returned deployment templates to be adapted to return only the elements allowed in that version.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "hide-deprecated", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, templates flagged as deprecated will NOT be returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": true, + "summary": "Region of the deployment templates", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployment-templates" + ], + "name": "get-deployment-template-v2", + "summary": "Get deployment template", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "template-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The identifier for the deployment template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-instance-configurations", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will return details for each instance configuration referenced by the template.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-max-zones", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stack-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "If present, it will cause the returned deployment template to be adapted to return only the elements allowed in that version.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": true, + "summary": "Region of the deployment template", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "deployments", + "summary": "Cloud hosted deployments commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "list-deployments", + "summary": "List Deployments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "create-deployment", + "summary": "Create Deployment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "request-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "An optional idempotency token - if two create requests share the same request_id token (min size 32 characters, max 128) then only one deployment will be created, the second request will return the info of that deployment (in the same format described below, but with blanks for auth-related fields)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "validate-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will just validate the Deployment definition but will not perform the creation", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "template-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "An optional template id - if present, the referenced template will be used to fill in the resources field of the deployment creation request. If any resources are present in the request together with the template, the ones coming in the request will prevail and no merging with the template will be performed.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "search-deployments", + "summary": "Search Deployments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "minimal-metadata", + "shortName": null, + "type": "string", + "required": false, + "summary": "Comma separated list of attributes to include in response for deployments found. Useful for reducing response size when retrieving many deployments. Use of this parameter moves the result to the minimal_metadata section of the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "search-eligible-remote-clusters", + "summary": "Get eligible remote clusters", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "cloud-version", + "shortName": null, + "type": "string", + "required": true, + "summary": "The version of the Elasticsearch cluster cluster that will potentially be configured to have remote clusters.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment", + "summary": "Get Deployment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-security", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full current and pending plan information in the response - can be large per cluster", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-logs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-history", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the plan history with the current and pending plan information. The results can be very large per cluster.\n By default, if a given resource kind (e.g. Elasticsearch, Kibana, etc.) has more than 100 plans\n (which should be very rare, most likely caused by a bug) only 100 plans are returned for the given resource type:\n The first 10 plans, and the last 90 plans for that resource type.\n If ALL of the plans are desired, pass the `force_all_plan_history` parameter with a value of `true`.\n", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to show values that are left at their default value (less readable but more informative)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "convert-legacy-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-system-alerts", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show cluster settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-instance-metrics", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show resources instance metrics in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-instance-configurations", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will return details for each instance configuration referenced by the deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enrich-with-template", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force-all-plan-history", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Force show the entire plan history no matter how long.\n As noted in the `show_plan_history` parameter description, by default, a maximum of 100 plans are shown per resource. \n If `true`, this parameter overrides the default, and ALL plans are returned.\n Use with care as the plan history can be VERY large. Consider pairing with `show_plan_logs=false`.\n ", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "clear-transient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "update-deployment", + "summary": "Update Deployment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "hide-pruned-orphans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "validate-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will just validate the Deployment definition but will not perform the update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cloud-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "restore-deployment", + "summary": "Restores a shutdown Deployment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "restore-snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether or not to restore a snapshot for those resources that allow it.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "shutdown-deployment", + "summary": "Shuts down Deployment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "hide", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether or not to skip snapshots before shutting down the resources", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-apm-resource-info", + "summary": "Get Deployment APM Resource Info", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full current and pending plan information in the response - can be large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-logs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-history", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show cluster settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "clear-transient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "deployment-apm-reset-secret-token", + "summary": "Reset the secret token for an APM resource.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-appsearch-resource-info", + "summary": "Get Deployment App Search Resource Info", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full current and pending plan information in the response - can be large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-logs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-history", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show cluster settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "clear-transient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-appsearch-read-only-mode", + "summary": "Set AppSearch read-only status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "set-appsearch-read-only-mode", + "summary": "Set AppSearch read-only status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-certificate-authority", + "summary": "Get certificate authority", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-es-resource-info", + "summary": "Get Deployment Elasticsearch Resource Info", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-security", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full current and pending plan information in the response - can be large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-logs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-history", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "convert-legacy-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-system-alerts", + "shortName": null, + "type": "number", + "required": false, + "summary": "Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show cluster settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "enrich-with-template", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "clear-transient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "enable-deployment-resource-ccr", + "summary": "Migrate Elasticsearch and associated Kibana resources to enable CCR", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "validate-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When `true`, will not enable CCR but returns warnings if any elements may lose availability during CCR enablement", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "enable-deployment-resource-ilm", + "summary": "Migrate Elasticsearch resource to use ILM", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "validate-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When `true`, does not enable ILM but returns warnings if any applications may lose availability during ILM migration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "enable-deployment-resource-slm", + "summary": "Migrate Elasticsearch resource to use SLM", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "validate-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When `true`, does not enable SLM but returns warnings if any applications may lose availability during SLM migration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "reset-elasticsearch-user-password", + "summary": "Reset 'elastic' user password", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "check-completion", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will not reset elastic user password and instead will return a status code signaling whether or not the current credentials are ready to use (eg from creation or the last call to _reset_password)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "restart-deployment-es-resource", + "summary": "Restart Deployment Elasticsearch Resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "restore-snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will not take a snapshot of the cluster before restarting.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cancel-pending", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "group-attribute", + "shortName": null, + "type": "string", + "required": false, + "summary": "Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: '\\_\\_all\\_\\_' (restart all at once), '\\_\\_zone\\_\\_' by logical zone, '\\_\\_name\\_\\_' one instance at a time, or a comma-separated list of attributes of the instances", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "shard-init-wait-time", + "shortName": null, + "type": "number", + "required": false, + "summary": "The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "shutdown-deployment-es-resource", + "summary": "Shutdown Deployment Elasticsearch Resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "hide", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-es-resource-eligible-remote-clusters", + "summary": "Get eligible remote clusters", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-es-resource-keystore", + "summary": "Get the items in the Elasticsearch resource keystore", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "set-deployment-es-resource-keystore", + "summary": "Add or remove items from the Elasticsearch resource keystore", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "validate-only", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When `true`, does nothing except return the entries' allowlist and reloadability statuses.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-es-resource-remote-clusters", + "summary": "Get certificate based remote clusters", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "set-deployment-es-resource-remote-clusters", + "summary": "Set certificate based remote clusters", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-es-resource-snapshot-repository", + "summary": "List the attached snapshot repositories", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "create-deployment-es-resource-snapshot-repository", + "summary": "Create a snapshot repository for Elasticsearch resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "delete-deployment-es-resource-snapshot-repository", + "summary": "Remove the attached snapshot repository", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "repository-name", + "shortName": null, + "type": "string", + "required": true, + "summary": "The name of the snapshot repository to remove (e.g. _clone_abcd1234)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "update-deployment-es-resource-tier", + "summary": "Update Elasticsearch tiers", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-enterprise-search-resource-info", + "summary": "Get Deployment Enterprise Search Resource Info", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full current and pending plan information in the response - can be large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-logs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-history", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show cluster settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "clear-transient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-integrations-server-resource-info", + "summary": "Get Deployment Integrations Server Resource Info", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full current and pending plan information in the response - can be large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-logs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-history", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show cluster settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "clear-transient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-kib-resource-info", + "summary": "Get Deployment Kibana Resource Info", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-metadata", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include the full current and pending plan information in the response - can be large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-logs", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-history", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-plan-defaults", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "convert-legacy-plans", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-settings", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show cluster settings in the response.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "clear-transient", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "migrate-deployment-template", + "summary": "Build request to migrate deployment to a different template", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "template-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the deployment template to migrate to", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-instance-metrics-check", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will skip the instance metrics check for memory and disk usage calculations", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-tags", + "summary": "Get the tags for a Deployment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "set-deployment-tags", + "summary": "Set the tags for a Deployment", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-upgrade-assistant-status", + "summary": "Get Deployment upgrade assistant status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "target-version", + "shortName": null, + "type": "string", + "required": false, + "summary": "If present, value is included in resource request to provide additional context (only supported for Kibana)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "restore-deployment-resource", + "summary": "Restores a shutdown resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "restore-snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether or not to restore a snapshot for those resources that allow it.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "start-deployment-resource-instances-all", + "summary": "Start all instances", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "stop-deployment-resource-instances-all", + "summary": "Stop all instances", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "start-deployment-resource-instances-all-maintenance-mode", + "summary": "Start maintenance mode (all instances)", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "stop-deployment-resource-instances-all-maintenance-mode", + "summary": "Stop maintenance mode (all instances)", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "start-deployment-resource-instances", + "summary": "Start instances", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "instance-ids", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of instance identifiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "stop-deployment-resource-instances", + "summary": "Stop instances", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "instance-ids", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of instance identifiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "start-deployment-resource-maintenance-mode", + "summary": "Start maintenance mode", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "instance-ids", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of instance identifiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "stop-deployment-resource-maintenance-mode", + "summary": "Stop maintenance mode", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "instance-ids", + "shortName": null, + "type": "string", + "required": true, + "summary": "A comma-separated list of instance identifiers.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "cancel-deployment-resource-pending-plan", + "summary": "Cancel resource pending plan", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force-delete", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When `true`, deletes the pending plan instead of attempting a graceful cancellation. The default is `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-missing", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When `true`, returns successfully, even when plans are missing. The default is `false`.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "get-deployment-resource-user-settings", + "summary": "Get the user settings of a Deployment resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "update-deployment-resource-user-settings", + "summary": "Update user settings for a deployment resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of resource", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "restart-deployment-stateless-resource", + "summary": "Restart Deployment Stateless Resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stateless-resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of stateless resource", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cancel-pending", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments" + ], + "name": "shutdown-deployment-stateless-resource", + "summary": "Shutdown Deployment Stateless Resource", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "deployment-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Identifier for the Deployment.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "stateless-resource-kind", + "shortName": null, + "type": "string", + "required": true, + "summary": "The kind of stateless resource", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ref-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "User-specified RefId for the Resource (or '_main' if there is only one).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "hide", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "skip-snapshot", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "deployments-traffic-filter", + "summary": "Cloud hosted deployments-traffic-filter commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "get-traffic-filter-deployment-ruleset-associations", + "summary": "Get associated rulesets", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "association-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "Association type", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "associated-entity-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Associated entity ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "get-traffic-filter-claimed-link-ids", + "summary": "List traffic filter claimed link id", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": false, + "summary": "If provided limits the claimed id to that region only.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "claim-traffic-filter-link-id", + "summary": "Claim a link id", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "unclaim-traffic-filter-link-id", + "summary": "Unclaims a link id", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "get-traffic-filter-rulesets", + "summary": "List traffic filter rulesets", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "include-associations", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Retrieves a list of resources that are associated to the specified ruleset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": false, + "summary": "If provided limits the rulesets to that region only.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "organization-id", + "shortName": null, + "type": "string", + "required": false, + "summary": "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "create-traffic-filter-ruleset", + "summary": "Create a ruleset", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "get-traffic-filter-ruleset", + "summary": "Retrieves the ruleset by ID.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The mandatory ruleset ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-associations", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Retrieves a list of resources that are associated to the specified ruleset.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "update-traffic-filter-ruleset", + "summary": "Updates a ruleset", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The mandatory ruleset ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "delete-traffic-filter-ruleset", + "summary": "Delete a ruleset", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The mandatory ruleset ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "ignore-associations", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "When true, ignores the associations and deletes the ruleset. When false, recognizes the associations, which prevents the deletion of the rule set.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "get-traffic-filter-ruleset-deployment-associations", + "summary": "Get associated deployments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The mandatory ruleset ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "create-traffic-filter-ruleset-association", + "summary": "Create ruleset association", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The mandatory ruleset ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "deployments-traffic-filter" + ], + "name": "delete-traffic-filter-ruleset-association", + "summary": "Delete ruleset association", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "ruleset-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The mandatory ruleset ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "association-type", + "shortName": null, + "type": "string", + "required": true, + "summary": "Association type", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "associated-entity-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Associated entity ID", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "extensions", + "summary": "Cloud hosted extensions commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "hosted", + "extensions" + ], + "name": "list-extensions", + "summary": "List Extensions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "extensions" + ], + "name": "create-extension", + "summary": "Create an extension", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "extensions" + ], + "name": "get-extension", + "summary": "Get Extension", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "extension-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Id of an extension", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "include-deployments", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Include deployments referencing this extension. Up to only 10000 deployments will be included.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "extensions" + ], + "name": "update-extension", + "summary": "Update Extension", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "extension-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Id of an extension", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "extensions" + ], + "name": "upload-extension", + "summary": "Uploads the Extension", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "extension-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Id of an extension", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "hosted", + "extensions" + ], + "name": "delete-extension", + "summary": "Delete Extension", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "extension-id", + "shortName": null, + "type": "string", + "required": true, + "summary": "Id of an extension", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "stack", + "summary": "Cloud hosted stack commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "hosted", + "stack" + ], + "name": "get-version-stacks", + "summary": "Get stack versions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "show-deleted", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show deleted stack versions or not", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "show-unusable", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Whether to show versions that are unusable by the authenticated user", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "trusted-environments", + "summary": "Cloud hosted trusted-environments commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "hosted", + "trusted-environments" + ], + "name": "get-trusted-envs", + "summary": "Get trusted environments", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + } + ] + }, + { + "segment": "serverless", + "summary": "Manage Elastic Serverless projects and resources", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "es", + "summary": "Elastic Serverless elasticsearch commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "projects", + "summary": "Manage elasticsearch projects", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "list", + "summary": "Get Elasticsearch projects", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "traffic-filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filters the returned list of projects. Only projects associated with the provided traffic_filter will be returned.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "linked", + "shortName": null, + "type": "string", + "required": false, + "summary": "Contains a project ID. If specified, the result will be filtered to only those origin projects that are linked to the specified project ID in a cross-project search configuration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "create", + "summary": "Create an Elasticsearch project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Wait for the project to reach \"initialized\" phase before returning", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "save-as", + "shortName": null, + "type": "string", + "required": false, + "summary": "store returned credentials in the OS keychain and upsert a context of this name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "credentials-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "write credentials to a standalone YAML config fragment at this path (0600)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "override the config file written by --save-as (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "overwrite an existing context (--save-as) or file (--credentials-file)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "get", + "summary": "Get an Elasticsearch project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "delete", + "summary": "Delete an Elasticsearch project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "patch", + "summary": "Update an Elasticsearch project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "reset-credentials", + "summary": "Reset the project credentials", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "save-as", + "shortName": null, + "type": "string", + "required": false, + "summary": "store returned credentials in the OS keychain and upsert a context of this name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "credentials-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "write credentials to a standalone YAML config fragment at this path (0600)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "override the config file written by --save-as (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "overwrite an existing context (--save-as) or file (--credentials-file)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "resume", + "summary": "Resume Elasticsearch project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "get-roles", + "summary": "Get roles for an Elasticsearch project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "es", + "projects" + ], + "name": "get-status", + "summary": "Get the status of an Elasticsearch project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + } + ] + }, + { + "segment": "observability", + "summary": "Elastic Serverless observability commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "projects", + "summary": "Manage observability projects", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "list", + "summary": "Get Observability projects", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "traffic-filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "traffic filters associated with this project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "linked", + "shortName": null, + "type": "string", + "required": false, + "summary": "Contains a project ID. If specified, the result will be filtered to only those origin projects that are linked to the specified project ID in a cross-project search configuration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "create", + "summary": "Create an observability project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Wait for the project to reach \"initialized\" phase before returning", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "save-as", + "shortName": null, + "type": "string", + "required": false, + "summary": "store returned credentials in the OS keychain and upsert a context of this name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "credentials-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "write credentials to a standalone YAML config fragment at this path (0600)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "override the config file written by --save-as (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "overwrite an existing context (--save-as) or file (--credentials-file)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "get", + "summary": "Get an Observability project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "delete", + "summary": "Delete an Observability project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "patch", + "summary": "Update an Observability project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "reset-credentials", + "summary": "Reset the project credentials", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "save-as", + "shortName": null, + "type": "string", + "required": false, + "summary": "store returned credentials in the OS keychain and upsert a context of this name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "credentials-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "write credentials to a standalone YAML config fragment at this path (0600)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "override the config file written by --save-as (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "overwrite an existing context (--save-as) or file (--credentials-file)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "resume", + "summary": "Resume Observability project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "get-roles", + "summary": "Get roles for an Observability project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "observability", + "projects" + ], + "name": "get-status", + "summary": "Get the status of an Observability project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + } + ] + }, + { + "segment": "security", + "summary": "Elastic Serverless security commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "projects", + "summary": "Manage security projects", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "list", + "summary": "Get Security projects", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "traffic-filter", + "shortName": null, + "type": "string", + "required": false, + "summary": "traffic filters associated with this project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "linked", + "shortName": null, + "type": "string", + "required": false, + "summary": "Contains a project ID. If specified, the result will be filtered to only those origin projects that are linked to the specified project ID in a cross-project search configuration.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "create", + "summary": "Create a security project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "wait", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Wait for the project to reach \"initialized\" phase before returning", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "save-as", + "shortName": null, + "type": "string", + "required": false, + "summary": "store returned credentials in the OS keychain and upsert a context of this name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "credentials-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "write credentials to a standalone YAML config fragment at this path (0600)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "override the config file written by --save-as (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "overwrite an existing context (--save-as) or file (--credentials-file)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "get", + "summary": "Get a Security project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "delete", + "summary": "Delete a Security project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "patch", + "summary": "Update a Security project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "reset-credentials", + "summary": "Reset the project credentials", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "save-as", + "shortName": null, + "type": "string", + "required": false, + "summary": "store returned credentials in the OS keychain and upsert a context of this name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "credentials-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "write credentials to a standalone YAML config fragment at this path (0600)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "override the config file written by --save-as (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "overwrite an existing context (--save-as) or file (--credentials-file)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "resume", + "summary": "Resume Security project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "get-roles", + "summary": "Get roles for a Security project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "security", + "projects" + ], + "name": "get-status", + "summary": "Get the status of a Security project", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + } + ] + }, + { + "segment": "linked-candidate-projects", + "summary": "Serverless linked-candidate-projects commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "serverless", + "linked-candidate-projects" + ], + "name": "get-elasticsearch-project-link-candidates", + "summary": "Get Elasticsearch project link candidates", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "types", + "shortName": null, + "type": "string", + "required": false, + "summary": "One or more types of projects to return as link candidates.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "csp", + "shortName": null, + "type": "string", + "required": false, + "summary": "The Cloud Service Provider to filter the link candidate projects by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": false, + "summary": "The region to filter the link candidate projects by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The project name to filter the link candidates by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alias", + "shortName": null, + "type": "string", + "required": false, + "summary": "The project alias to filter the link candidates by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "linked-candidate-projects" + ], + "name": "get-observability-project-link-candidates", + "summary": "Get Observability project link candidates", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "types", + "shortName": null, + "type": "string", + "required": false, + "summary": "One or more types of projects to return as link candidates.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "csp", + "shortName": null, + "type": "string", + "required": false, + "summary": "The Cloud Service Provider to filter the link candidate projects by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": false, + "summary": "The region to filter the link candidate projects by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The project name to filter the link candidates by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alias", + "shortName": null, + "type": "string", + "required": false, + "summary": "The project alias to filter the link candidates by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "linked-candidate-projects" + ], + "name": "get-security-project-link-candidates", + "summary": "Get Security project link candidates", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "types", + "shortName": null, + "type": "string", + "required": false, + "summary": "One or more types of projects to return as link candidates.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "csp", + "shortName": null, + "type": "string", + "required": false, + "summary": "The Cloud Service Provider to filter the link candidate projects by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": false, + "summary": "The region to filter the link candidate projects by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "name", + "shortName": null, + "type": "string", + "required": false, + "summary": "The project name to filter the link candidates by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "alias", + "shortName": null, + "type": "string", + "required": false, + "summary": "The project alias to filter the link candidates by.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "linked-projects", + "summary": "Serverless linked-projects commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "serverless", + "linked-projects" + ], + "name": "get-elasticsearch-project-can-delete", + "summary": "Get Elasticsearch project delete status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "linked-projects" + ], + "name": "get-observability-project-can-delete", + "summary": "Get Observability project delete status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "linked-projects" + ], + "name": "get-security-project-can-delete", + "summary": "Get Security project delete status", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The ID of the project", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "regions", + "summary": "Serverless regions commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "serverless", + "regions" + ], + "name": "list-regions", + "summary": "Get regions", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "regions" + ], + "name": "get-region", + "summary": "Get a region", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "ID of the region", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "traffic-filters", + "summary": "Serverless traffic-filters commands", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "cloud", + "serverless", + "traffic-filters" + ], + "name": "list-traffic-filters", + "summary": "List traffic filters", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "include-by-default", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Retrieves a list of resources that have include_by_default set or not set", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": false, + "summary": "If provided limits the traffic filters to that region only.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "traffic-filters" + ], + "name": "create-traffic-filter", + "summary": "Create a traffic filter", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "traffic-filters" + ], + "name": "get-traffic-filter-metadata", + "summary": "List PrivateLink region metadata", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "region", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter metadata to a specific region (e.g. aws-eu-west-1, azure-australiaeast).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "csp", + "shortName": null, + "type": "string", + "required": false, + "summary": "Filter metadata to a specific cloud service provider (aws, azure, gcp).", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "traffic-filters" + ], + "name": "get-traffic-filter", + "summary": "Retrieves the traffic filter by ID.", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The traffic filter ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "traffic-filters" + ], + "name": "delete-traffic-filter", + "summary": "Delete a traffic filter", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The traffic filter ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "cloud", + "serverless", + "traffic-filters" + ], + "name": "patch-traffic-filter", + "summary": "Updates a traffic filter", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "id", + "shortName": null, + "type": "string", + "required": true, + "summary": "The traffic filter ID.", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + } + ] + } + ] + }, + { + "segment": "docs", + "summary": "Search, read, and ask questions about Elastic documentation", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "docs" + ], + "name": "search", + "summary": "Search Elastic documentation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "query", + "shortName": null, + "type": "string", + "required": true, + "summary": "Search terms", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "page", + "shortName": null, + "type": "number", + "required": false, + "summary": "Page number", + "defaultValue": "1", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "size", + "shortName": null, + "type": "number", + "required": false, + "summary": "Results per page", + "defaultValue": "5", + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "docs" + ], + "name": "ask", + "summary": "Ask a question about Elastic documentation using AI (single answer)", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "question", + "shortName": null, + "type": "string", + "required": true, + "summary": "Question to ask", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "docs" + ], + "name": "chat", + "summary": "Ask a question about Elastic documentation using AI, with follow-up conversation", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "question", + "shortName": null, + "type": "string", + "required": true, + "summary": "Opening question", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "docs" + ], + "name": "read", + "summary": "Read an Elastic documentation page", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "path", + "shortName": null, + "type": "string", + "required": true, + "summary": "Docs path, full elastic.co URL, or search query", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "raw", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "Output unrendered markdown instead of formatted output", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "input-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "config", + "summary": "Author and maintain the elastic config file", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [], + "namespaces": [ + { + "segment": "context", + "summary": "Manage contexts in the elastic config file", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "config", + "context" + ], + "name": "list", + "summary": "List all contexts defined in the config file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to the config file to edit (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "config", + "context" + ], + "name": "add", + "summary": "Add a new context to the config file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Positional", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "context name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to the config file to edit (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "overwrite an existing context with the same name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inline-secrets", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "store secrets inline in the config file (instead of the OS keychain)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "es-url", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elasticsearch URL", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "es-username", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elasticsearch username (pair with --es-password)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-url", + "shortName": null, + "type": "string", + "required": false, + "summary": "Kibana URL", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-username", + "shortName": null, + "type": "string", + "required": false, + "summary": "Kibana username (pair with --kb-password)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cloud-url", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elastic Cloud API URL", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "es-api-key", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elasticsearch API key (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "es-password", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elasticsearch password (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-api-key", + "shortName": null, + "type": "string", + "required": false, + "summary": "Kibana API key (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-password", + "shortName": null, + "type": "string", + "required": false, + "summary": "Kibana password (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cloud-api-key", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elastic Cloud API key (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "config", + "context" + ], + "name": "edit", + "summary": "Edit an existing context (flag-patch or $EDITOR mode)", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Positional", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "context name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to the config file to edit (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "inline-secrets", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "store secrets inline in the config file (instead of the OS keychain)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "es-url", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elasticsearch URL", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "es-username", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elasticsearch username (pair with --es-password)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-url", + "shortName": null, + "type": "string", + "required": false, + "summary": "Kibana URL", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-username", + "shortName": null, + "type": "string", + "required": false, + "summary": "Kibana username (pair with --kb-password)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cloud-url", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elastic Cloud API URL", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "es-api-key", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elasticsearch API key (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "es-password", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elasticsearch password (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-api-key", + "shortName": null, + "type": "string", + "required": false, + "summary": "Kibana API key (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "kb-password", + "shortName": null, + "type": "string", + "required": false, + "summary": "Kibana password (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "cloud-api-key", + "shortName": null, + "type": "string", + "required": false, + "summary": "Elastic Cloud API key (secret -- stored in the OS keychain when available)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "config", + "context" + ], + "name": "remove", + "summary": "Remove a context from the config file", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Positional", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "context name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to the config file to edit (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "force", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "allow removing the current context", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + }, + { + "segment": "current-context", + "summary": "View or change the current context", + "notes": null, + "options": [], + "defaultCommand": null, + "commands": [ + { + "path": [ + "config", + "current-context" + ], + "name": "get", + "summary": "Print the current context name", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to the config file to edit (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + }, + { + "path": [ + "config", + "current-context" + ], + "name": "set", + "summary": "Change the current context", + "notes": null, + "usage": null, + "examples": [], + "parameters": [ + { + "role": "Positional", + "name": "name", + "shortName": null, + "type": "string", + "required": true, + "summary": "context name", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "config-file", + "shortName": null, + "type": "string", + "required": false, + "summary": "path to the config file to edit (defaults to ~/.elasticrc.yml)", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + }, + { + "role": "Named", + "name": "dry-run", + "shortName": null, + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action", + "defaultValue": null, + "repeatable": false, + "separator": null, + "aliases": null, + "enumValues": null, + "elementType": null, + "hidden": false, + "validations": null + } + ], + "aliases": null, + "hidden": false + } + ], + "namespaces": [] + } + ] + } + ] +} diff --git a/docs/docset.yml b/docs/docset.yml new file mode 100644 index 0000000..df7675a --- /dev/null +++ b/docs/docset.yml @@ -0,0 +1,10 @@ +project: elastic-cli +dev_docs: true + +toc: + - file: index.md + - cli: cli/schema.json + folder: cli + children: + - file: installation.md + - file: configuration.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..050009d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Elastic CLI + +Interact with the Elastic Stack and Elastic Cloud from the command line. diff --git a/package.json b/package.json index a2d8e4d..dce1d17 100644 --- a/package.json +++ b/package.json @@ -25,6 +25,7 @@ "test:functional:kb": "bash test/functional/kb/run.sh", "test:license": "license-checker --production", "test:spdx": "./scripts/check-spdx", + "build:schema": "node --import tsx/esm src/cli.ts cli-schema > docs/cli/schema.json", "generate:notice": "node scripts/generate-notice.mjs", "test:notice": "node scripts/generate-notice.mjs --check", "test:megalinter": "mega-linter-runner --flavor javascript" diff --git a/src/cli-schema.ts b/src/cli-schema.ts new file mode 100644 index 0000000..0a233ab --- /dev/null +++ b/src/cli-schema.ts @@ -0,0 +1,479 @@ +/* + * Copyright Elasticsearch B.V. and contributors + * SPDX-License-Identifier: Apache-2.0 + */ + +import { Command } from 'commander' +import { z } from 'zod' +import { defineCommand } from './factory.ts' +import { stripTransportMeta } from './factory.ts' +import type { OpaqueCommandHandle, CommandConfig, JsonValue } from './factory.ts' +import type { SchemaArgDefinition } from './lib/schema-args.ts' +import { NAMESPACES } from './namespaces.ts' + +// --------------------------------------------------------------------------- +// Argh schema types +// --------------------------------------------------------------------------- + +interface ArghValidation { + kind: string + min?: string | null + max?: string | null + pattern?: string | null + values?: (string | null)[] | null +} + +interface ArghParameter { + role: string + name: string + shortName: string | null + type: string + required: boolean + summary: string | null + defaultValue: string | null + repeatable: boolean + separator: string | null + aliases: (string | null)[] | null + enumValues: (string | null)[] | null + elementType: string | null + hidden: boolean + validations: ArghValidation[] | null +} + +interface ArghCommand { + path: (string | null)[] + name: string + summary: string | null + notes: string | null + usage: string | null + examples: (string | null)[] + parameters: ArghParameter[] + aliases: (string | null)[] | null + hidden: boolean +} + +interface ArghNamespace { + segment: string + summary: string | null + notes: string | null + options: ArghParameter[] + defaultCommand: null + commands: ArghCommand[] + namespaces: ArghNamespace[] +} + +interface ArghSchema { + schemaVersion: string + name: string + version: string + description: string | null + reservedMetaCommands: (string | null)[] + globalOptions: ArghParameter[] + rootDefault: null + commands: ArghCommand[] + namespaces: ArghNamespace[] +} + +// --------------------------------------------------------------------------- +// Commander introspection helpers +// --------------------------------------------------------------------------- + +interface AttachedConfig { + config: CommandConfig + schemaArgs: SchemaArgDefinition[] +} + +function getAttachedConfig (cmd: OpaqueCommandHandle): AttachedConfig | undefined { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + return (cmd as unknown as any)._commandConfig as AttachedConfig | undefined +} + +function isHidden (cmd: OpaqueCommandHandle): boolean { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + return (cmd as unknown as any)._hidden === true +} + +function commandAliases (cmd: OpaqueCommandHandle): (string | null)[] | null { + const list = cmd.aliases() as string[] + return list.length > 0 ? list : null +} + +// --------------------------------------------------------------------------- +// JSON Schema extraction helpers +// --------------------------------------------------------------------------- + +type JsonSchemaNode = Record + +function resolveRef (node: JsonSchemaNode, root: JsonSchemaNode): JsonSchemaNode { + const ref = node['$ref'] + if (typeof ref !== 'string') return node + const parts = ref.replace(/^#\//, '').split('/') + let cur: unknown = root + for (const part of parts) { + if (cur == null || typeof cur !== 'object') return node + cur = (cur as JsonSchemaNode)[part] + } + return (cur != null && typeof cur === 'object') ? cur as JsonSchemaNode : node +} + +function unwrapNullable (node: JsonSchemaNode, root: JsonSchemaNode): JsonSchemaNode { + const anyOf = node['anyOf'] + if (!Array.isArray(anyOf)) return node + const nonNull = anyOf.find((b: unknown) => { + if (b == null || typeof b !== 'object') return false + const branch = b as JsonSchemaNode + return branch['type'] !== 'null' && branch['const'] !== null + }) + return nonNull != null ? resolveRef(nonNull as JsonSchemaNode, root) : node +} + +function resolveNode (node: JsonSchemaNode, root: JsonSchemaNode): JsonSchemaNode { + return unwrapNullable(resolveRef(node, root), root) +} + +function extractEnumValues (node: JsonSchemaNode, root: JsonSchemaNode): (string | null)[] | null { + const resolved = resolveNode(node, root) + const enumVals = resolved['enum'] + if (!Array.isArray(enumVals) || enumVals.length === 0) return null + return enumVals.map((v) => (v == null ? null : String(v))) +} + +function extractElementType (node: JsonSchemaNode, root: JsonSchemaNode): string | null { + const resolved = resolveNode(node, root) + const items = resolved['items'] + if (items == null || typeof items !== 'object') return null + const resolvedItems = resolveNode(items as JsonSchemaNode, root) + const t = resolvedItems['type'] + return typeof t === 'string' ? t : null +} + +function extractValidations (node: JsonSchemaNode, root: JsonSchemaNode): ArghValidation[] | null { + const resolved = resolveNode(node, root) + const validations: ArghValidation[] = [] + + // Enum values are surfaced via the dedicated `enumValues` field; skip AllowedValues here. + + const min = resolved['minimum'] + const max = resolved['maximum'] + if (min !== undefined || max !== undefined) { + validations.push({ + kind: 'Range', + min: min !== undefined ? String(min) : null, + max: max !== undefined ? String(max) : null, + }) + } + + const pattern = resolved['pattern'] + if (typeof pattern === 'string') { + validations.push({ kind: 'Pattern', pattern }) + } + + return validations.length > 0 ? validations : null +} + +// --------------------------------------------------------------------------- +// Parameter builders +// --------------------------------------------------------------------------- + +/** Map SchemaArgDefinition.type to a language-agnostic type string. */ +function schemaArgType (arg: SchemaArgDefinition): string { + switch (arg.type) { + case 'boolean': return 'boolean' + case 'number': return 'number' + case 'object': return 'object' + case 'array': return 'array' + case 'enum': + case 'string': + default: return 'string' + } +} + +function buildGlobalParams (rootCmd: Command): ArghParameter[] { + return rootCmd.options.map((opt) => { + const isFlag = !opt.required && !opt.optional + return { + role: 'Named', + name: opt.long?.replace(/^--/, '') ?? '', + shortName: opt.short?.replace(/^-/, '') ?? null, + type: isFlag ? 'boolean' : 'string', + required: opt.mandatory ?? false, + summary: opt.description ?? null, + defaultValue: null, + repeatable: false, + separator: null, + aliases: null, + enumValues: null, + elementType: null, + hidden: false, + validations: null, + } + }) +} + +function buildCommandParams (cmd: OpaqueCommandHandle): ArghParameter[] { + const attached = getAttachedConfig(cmd) + const params: ArghParameter[] = [] + + let jsonSchema: JsonSchemaNode | undefined + let schemaRoot: JsonSchemaNode | undefined + if (attached?.config.input instanceof z.ZodType) { + const raw = stripTransportMeta( + z.toJSONSchema(attached.config.input, { reused: 'ref' }) as JsonValue + ) + jsonSchema = raw as unknown as JsonSchemaNode + schemaRoot = jsonSchema + } + + function propNode (schemaKey: string): JsonSchemaNode | null { + if (jsonSchema == null) return null + const props = jsonSchema['properties'] + if (props == null || typeof props !== 'object') return null + const p = (props as JsonSchemaNode)[schemaKey] + return (p != null && typeof p === 'object') ? p as JsonSchemaNode : null + } + + if (attached != null) { + // Positional arg + if (attached.config.positionalArg != null) { + const pa = attached.config.positionalArg + params.push({ + role: 'Positional', + name: pa.name, + shortName: null, + type: 'string', + required: pa.required !== false, + summary: pa.description ?? null, + defaultValue: null, + repeatable: false, + separator: null, + aliases: null, + enumValues: null, + elementType: null, + hidden: false, + validations: null, + }) + } + + // Hand-declared options (OptionDefinition[]) + for (const opt of (attached.config.options ?? [])) { + params.push({ + role: 'Named', + name: opt.long, + shortName: opt.short ?? null, + type: opt.type === 'boolean' ? 'boolean' : opt.type === 'number' ? 'number' : 'string', + required: opt.required ?? false, + summary: opt.description ?? null, + defaultValue: opt.defaultValue != null ? String(opt.defaultValue) : null, + repeatable: false, + separator: null, + aliases: null, + enumValues: null, + elementType: null, + hidden: false, + validations: null, + }) + } + + // Schema-derived options (from extractSchemaArgs) + for (const arg of attached.schemaArgs) { + const node = propNode(arg.schemaKey) + const root = schemaRoot ?? {} + params.push({ + role: 'Named', + name: arg.cliFlag, + shortName: null, + type: schemaArgType(arg), + required: arg.required, + summary: arg.description ?? null, + defaultValue: arg.defaultValue != null ? String(arg.defaultValue) : null, + repeatable: arg.acceptsArrayForm === true, + separator: arg.acceptsArrayForm === true && arg.foundIn === 'body' ? ',' : null, + aliases: null, + enumValues: node != null ? extractEnumValues(node, root) : null, + elementType: arg.type === 'array' && node != null ? extractElementType(node, root) : null, + hidden: false, + validations: node != null ? extractValidations(node, root) : null, + }) + } + + // Framework-injected options: --input-file and --dry-run (not in OptionDefinition[]) + const coveredLong = new Set([ + ...(attached.config.options ?? []).map((o) => `--${o.long}`), + ...attached.schemaArgs.map((a) => `--${a.cliFlag}`), + ]) + for (const opt of cmd.options) { + const long = opt.long ?? '' + if (coveredLong.has(long)) continue + const name = long.replace(/^--/, '') + if (!name) continue + const isFlag = !opt.required && !opt.optional + params.push({ + role: 'Named', + name, + shortName: opt.short?.replace(/^-/, '') ?? null, + type: isFlag ? 'boolean' : 'string', + required: opt.mandatory ?? false, + summary: opt.description ?? null, + defaultValue: null, + repeatable: false, + separator: null, + aliases: null, + enumValues: null, + elementType: null, + hidden: false, + validations: null, + }) + } + } else { + // Fallback: no attached config — introspect Commander directly + for (const opt of cmd.options) { + const name = (opt.long ?? '').replace(/^--/, '') + if (!name) continue + const isFlag = !opt.required && !opt.optional + params.push({ + role: 'Named', + name, + shortName: opt.short?.replace(/^-/, '') ?? null, + type: isFlag ? 'boolean' : 'string', + required: opt.mandatory ?? false, + summary: opt.description ?? null, + defaultValue: null, + repeatable: false, + separator: null, + aliases: null, + enumValues: null, + elementType: null, + hidden: false, + validations: null, + }) + } + } + + return params +} + +// --------------------------------------------------------------------------- +// Tree walker +// --------------------------------------------------------------------------- + +function buildLeafCommand (cmd: OpaqueCommandHandle, path: string[]): ArghCommand { + return { + path, + name: cmd.name(), + summary: cmd.description() || null, + notes: null, + usage: null, + examples: [], + parameters: buildCommandParams(cmd), + aliases: commandAliases(cmd), + hidden: false, + } +} + +function walkCommands ( + cmd: OpaqueCommandHandle, + pathSoFar: string[], + outCommands: ArghCommand[], +): ArghNamespace | null { + if (isHidden(cmd)) return null + + const subs = cmd.commands as OpaqueCommandHandle[] + const name = cmd.name() + + if (subs.length === 0) { + outCommands.push(buildLeafCommand(cmd, pathSoFar)) + return null + } + + const nsCommands: ArghCommand[] = [] + const nsNamespaces: ArghNamespace[] = [] + const childPath = [...pathSoFar, name] + + for (const sub of subs) { + if (isHidden(sub)) continue + const subSubs = sub.commands as OpaqueCommandHandle[] + if (subSubs.length === 0) { + nsCommands.push(buildLeafCommand(sub, childPath)) + } else { + const nested = walkCommands(sub, childPath, outCommands) + if (nested != null) nsNamespaces.push(nested) + } + } + + return { + segment: name, + summary: cmd.description() || null, + notes: null, + options: [], + defaultCommand: null, + commands: nsCommands, + namespaces: nsNamespaces, + } +} + +// --------------------------------------------------------------------------- +// Schema builder +// --------------------------------------------------------------------------- + +export function buildArghSchema ( + root: OpaqueCommandHandle, + globalOptions: ArghParameter[], + version: string, +): ArghSchema { + const allCommands: ArghCommand[] = [] + const namespaces: ArghNamespace[] = [] + + for (const sub of root.commands as OpaqueCommandHandle[]) { + if (isHidden(sub)) continue + const subSubs = sub.commands as OpaqueCommandHandle[] + if (subSubs.length === 0) { + allCommands.push(buildLeafCommand(sub, [])) + } else { + const ns = walkCommands(sub, [], allCommands) + if (ns != null) namespaces.push(ns) + } + } + + return { + schemaVersion: '1', + name: root.name() || 'elastic', + version, + description: root.description() || null, + reservedMetaCommands: ['cli-schema'], + globalOptions, + rootDefault: null, + commands: allCommands, + namespaces, + } +} + +// --------------------------------------------------------------------------- +// Command registration +// --------------------------------------------------------------------------- + +export async function registerCliSchemaCommand ( + version: string, + rootProgram: Command, +): Promise { + return defineCommand({ + name: 'cli-schema', + description: 'Emit the CLI structure as argh-schema JSON', + handler: async () => { + const schemaRoot = new Command(rootProgram.name()) + schemaRoot.description(rootProgram.description()) + + schemaRoot.addCommand(defineCommand({ + name: 'version', + description: 'Print the elastic CLI version', + handler: () => ({ version }), + })) + + const loaded = await Promise.all(NAMESPACES.map((ns) => ns.load({ eager: true }))) + for (const ns of loaded) schemaRoot.addCommand(ns) + + const globalOptions = buildGlobalParams(rootProgram) + return buildArghSchema(schemaRoot, globalOptions, version) as unknown as JsonValue + }, + formatOutput: (result) => JSON.stringify(result, null, 2) + '\n', + }) +} diff --git a/src/cli.ts b/src/cli.ts index 49ee67c..be9b4b9 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -47,6 +47,7 @@ program.hook('preAction', async (thisCommand, actionCommand) => { // `status` loads the config itself so a partially broken config is reported as // a structured result rather than exiting before any probe runs. if (actionCommand.name() === 'status') return + if (actionCommand.name() === 'cli-schema') return if (actionCommand.parent?.name() === 'docs') return if (actionCommand.parent?.name() === 'sanitize') return // `config` commands author the config file itself — loading it would be @@ -246,13 +247,20 @@ if (firstArg === 'status') { })) } +if (firstArg === 'cli-schema') { + const { registerCliSchemaCommand } = await import('./cli-schema.ts') + program.addCommand(await registerCliSchemaCommand(VERSION, program)) +} else { + program.addCommand(defineGroup({ name: 'cli-schema', description: 'Emit the CLI structure as argh-schema JSON' })) +} + // Load config early so --help can hide blocked commands. Skip for commands // that don't need config (e.g. `version`, `sanitize`, `config` which authors // the file, and the completion subsystem which runs before any context exists) // to avoid unnecessary file I/O and a confusing "no config found" path. // loadConfig() caches the result in-process; the preAction hook reuses it via the default cache path. const SKIP_EARLY_CONFIG = new Set([ - 'version', 'config', 'sanitize', 'extension', 'status', ...COMPLETION_COMMAND_NAMES, + 'version', 'config', 'sanitize', 'extension', 'status', 'cli-schema', ...COMPLETION_COMMAND_NAMES, ]) if (firstArg == null || !SKIP_EARLY_CONFIG.has(firstArg)) { // Parse --profile early (before Commander's full parse) so the early config load diff --git a/src/es/register.ts b/src/es/register.ts index 72a3542..8a690ab 100644 --- a/src/es/register.ts +++ b/src/es/register.ts @@ -229,6 +229,17 @@ export async function registerEsCommandsLazy ( return await buildLazyTree(apiManifest, opts.argv ?? process.argv) } +/** + * Eager path: loads ALL Elasticsearch API definitions upfront and registers + * them as full `defineCommand` commands with all options and `_commandConfig`. + * Use this when you need the complete command tree (e.g. schema generation). + * Callers that only need CLI startup should prefer {@link registerEsCommandsLazy}. + */ +export async function registerEsCommandsEager (): Promise { + const defs = await Promise.all(apiManifest.map((m) => loadEsApi(m))) + return buildEagerTree(defs) +} + /** Eager-tree builder: behaviourally identical to the original pre-lazy implementation. */ function buildEagerTree (definitions: EsApiDefinition[]): OpaqueCommandHandle { const defSchemaArgs = new Map() diff --git a/src/factory.ts b/src/factory.ts index 3adcb99..5dc3f38 100644 --- a/src/factory.ts +++ b/src/factory.ts @@ -383,13 +383,14 @@ function validateInput (name: string, input: unknown): void { /** * Recursively removes `found_in` keys from a JSON Schema object. + * Exported for reuse in cli-schema.ts validation extraction. * * `found_in` is internal routing metadata used by the request builder to classify * parameters as path, query, or body. It is an HTTP transport implementation detail * and MUST NOT be exposed in user-facing help text or agent-facing JSON Schema output * (Constitution Principle VIII: Transport-Layer Abstraction). */ -function stripTransportMeta (value: JsonValue): JsonValue { +export function stripTransportMeta (value: JsonValue): JsonValue { if (Array.isArray(value)) return value.map(stripTransportMeta) if (value !== null && typeof value === 'object') { const out: Record = {} @@ -622,6 +623,14 @@ export function defineCommand (config: CommandConfig): O config.input instanceof z.ZodType ? config.input : undefined, ) + // Attach typed metadata for tooling (e.g. cli-schema). Non-enumerable so it + // doesn't appear in JSON.stringify or Commander's own command inspection. + Object.defineProperty(cmd, '_commandConfig', { + value: { config, schemaArgs }, + writable: false, + enumerable: false, + }) + cmd.action(async () => { const allRaw = cmd.optsWithGlobals() const options: Record = {} diff --git a/src/namespaces.ts b/src/namespaces.ts new file mode 100644 index 0000000..48e05fd --- /dev/null +++ b/src/namespaces.ts @@ -0,0 +1,79 @@ +/* + * Copyright Elasticsearch B.V. and contributors + * SPDX-License-Identifier: Apache-2.0 + */ + +import { defineGroup } from './factory.ts' +import type { OpaqueCommandHandle } from './factory.ts' + +export interface LoadOptions { + /** + * When true, load all sub-commands eagerly (no lazy stubs). + * Used by `cli-schema` to ensure every leaf has `_commandConfig` attached. + * Callers that only need CLI startup should use the default (false). + */ + eager?: boolean +} + +/** + * Declarative entry for a top-level CLI namespace. + * + * This is the single source of truth for namespace registration. + * Both `cli.ts` (lazy stub/eager load) and `cli-schema` (always eager) consume + * this list. Adding a new top-level namespace requires only adding an entry here. + */ +export interface NamespaceEntry { + name: string + description: string + /** Fully load the namespace and return a registered command group handle. */ + load: (opts?: LoadOptions) => Promise +} + +export const NAMESPACES: NamespaceEntry[] = [ + { + name: 'stack', + description: 'Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)', + load: async (opts) => { + const eager = opts?.eager === true + const [esModule, { registerKbCommands }] = await Promise.all([ + import('./es/register.ts'), + import('./kb/register.ts'), + ]) + const esGroup = eager + ? await esModule.registerEsCommandsEager() + : await esModule.registerEsCommandsLazy() + esGroup.alias('elasticsearch') + const kbGroup = registerKbCommands() + kbGroup.alias('kibana') + return defineGroup( + { name: 'stack', description: 'Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)' }, + esGroup, + kbGroup, + ) + }, + }, + { + name: 'cloud', + description: 'Manage Elastic Cloud (hosted deployments and serverless projects)', + load: async () => { + const { registerCloudCommands } = await import('./cloud/register.ts') + return registerCloudCommands() + }, + }, + { + name: 'docs', + description: 'Search, read, and ask questions about Elastic documentation', + load: async () => { + const { registerDocsCommands } = await import('./docs/register.ts') + return registerDocsCommands() + }, + }, + { + name: 'config', + description: 'Author and maintain the elastic config file', + load: async () => { + const { registerConfigCommands } = await import('./config/commands.ts') + return registerConfigCommands() + }, + }, +] diff --git a/test/factory.test.ts b/test/factory.test.ts index fd62aaa..481e0e0 100644 --- a/test/factory.test.ts +++ b/test/factory.test.ts @@ -2791,7 +2791,7 @@ describe('no Commander API leaks', () => { it('factory module exports only public API and test seam at runtime', async () => { const factory = await import('../src/factory.ts') const exported = Object.keys(factory) - assert.deepEqual(exported.sort(), ['RawJsonValue', '_testSetStdinReader', 'defineCommand', 'defineGroup', 'hideBlockedCommands', 'isCommandAllowed']) + assert.deepEqual(exported.sort(), ['RawJsonValue', '_testSetStdinReader', 'defineCommand', 'defineGroup', 'hideBlockedCommands', 'isCommandAllowed', 'stripTransportMeta']) }) it('defineCommand return value requires no Commander import to use', () => { From 2919a8f9e321964ca81a89243b3f3bfc8dcb4e86 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Wed, 20 May 2026 09:51:34 +0200 Subject: [PATCH 02/10] refactor: move cli-schema into NAMESPACES, make it data-driven Add cli-schema (and sanitize) to namespaces.ts alongside all other top-level namespaces. cli.ts now uses a single NAMESPACES loop for all commands rather than scattered if/else blocks, and skipConfig metadata drives both the preAction hook and early config load instead of hard-coded name checks. Breaks the potential circular import between cli-schema.ts and namespaces.ts by inverting the dependency: namespaces passes the namespace list as a parameter to registerCliSchemaCommand rather than cli-schema.ts importing NAMESPACES directly. Also fixes the unused OpaqueCommandHandle import (MegaLinter lint error) and the registerKbCommands arity regression introduced by the rebase onto main. Co-Authored-By: Claude Sonnet 4.6 --- src/cli-schema.ts | 13 ++++--- src/cli.ts | 98 ++++++++--------------------------------------- src/namespaces.ts | 43 ++++++++++++++++++++- 3 files changed, 64 insertions(+), 90 deletions(-) diff --git a/src/cli-schema.ts b/src/cli-schema.ts index 0a233ab..b64df9d 100644 --- a/src/cli-schema.ts +++ b/src/cli-schema.ts @@ -9,7 +9,7 @@ import { defineCommand } from './factory.ts' import { stripTransportMeta } from './factory.ts' import type { OpaqueCommandHandle, CommandConfig, JsonValue } from './factory.ts' import type { SchemaArgDefinition } from './lib/schema-args.ts' -import { NAMESPACES } from './namespaces.ts' +import type { NamespaceEntry } from './namespaces.ts' // --------------------------------------------------------------------------- // Argh schema types @@ -453,14 +453,15 @@ export function buildArghSchema ( export async function registerCliSchemaCommand ( version: string, - rootProgram: Command, + rootProgram: Command | undefined, + namespaces: NamespaceEntry[], ): Promise { return defineCommand({ name: 'cli-schema', description: 'Emit the CLI structure as argh-schema JSON', handler: async () => { - const schemaRoot = new Command(rootProgram.name()) - schemaRoot.description(rootProgram.description()) + const schemaRoot = new Command(rootProgram?.name() ?? 'elastic') + schemaRoot.description(rootProgram?.description() ?? '') schemaRoot.addCommand(defineCommand({ name: 'version', @@ -468,10 +469,10 @@ export async function registerCliSchemaCommand ( handler: () => ({ version }), })) - const loaded = await Promise.all(NAMESPACES.map((ns) => ns.load({ eager: true }))) + const loaded = await Promise.all(namespaces.map((ns) => ns.load({ eager: true }))) for (const ns of loaded) schemaRoot.addCommand(ns) - const globalOptions = buildGlobalParams(rootProgram) + const globalOptions = rootProgram != null ? buildGlobalParams(rootProgram) : [] return buildArghSchema(schemaRoot, globalOptions, version) as unknown as JsonValue }, formatOutput: (result) => JSON.stringify(result, null, 2) + '\n', diff --git a/src/cli.ts b/src/cli.ts index be9b4b9..40bc025 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -13,6 +13,7 @@ import { setResolvedConfig } from './config/store.ts' import { renderLogo } from './lib/logo.ts' import { rewriteTopLevelAliases } from './completion/argv-aliases.ts' import { registerCompletionCommands, COMPLETION_COMMAND_NAMES } from './completion/index.ts' +import { NAMESPACES } from './namespaces.ts' // x-release-please-start-version const VERSION = '0.1.1'; @@ -35,8 +36,8 @@ program // On error, print a structured message and exit -- never let a config failure // silently propagate into the command handler. // -// When no --config-file or --use-context overrides are specified, loadConfig() -// returns the in-process cached result from the early load, avoiding redundant I/O. +const skipConfigNames = new Set(NAMESPACES.filter(ns => ns.skipConfig).map(ns => ns.name)) + program.hook('preAction', async (thisCommand, actionCommand) => { if (actionCommand.name() === 'version') return // Shell completion commands must not depend on a working config: the user @@ -47,13 +48,9 @@ program.hook('preAction', async (thisCommand, actionCommand) => { // `status` loads the config itself so a partially broken config is reported as // a structured result rather than exiting before any probe runs. if (actionCommand.name() === 'status') return - if (actionCommand.name() === 'cli-schema') return - if (actionCommand.parent?.name() === 'docs') return - if (actionCommand.parent?.name() === 'sanitize') return - // `config` commands author the config file itself — loading it would be - // circular (and must tolerate the absence of a file) - for (let c = actionCommand.parent; c != null; c = c.parent) { - if (c.name() === 'config') return + // Walk up the command tree — if any ancestor is a skipConfig namespace, skip config loading. + for (let c: Command | null = actionCommand; c != null; c = c.parent) { + if (skipConfigNames.has(c.name())) return } // `extension` commands manage the extension registry, not the Elastic stack for (let c = actionCommand.parent; c != null; c = c.parent) { @@ -150,41 +147,14 @@ if (aliasRewritten.length !== operands.length) { firstArg = 'stack' } -if (firstArg === 'stack') { - const stackChildren: OpaqueCommandHandle[] = [] - - const secondArg = operands[1] - const esArgs = new Set(['es', 'elasticsearch']) - const kbArgs = new Set(['kb', 'kibana']) - - if (secondArg == null || esArgs.has(secondArg)) { - const { registerEsCommandsLazy } = await import('./es/register.ts') - const esGroup = await registerEsCommandsLazy() - esGroup.alias('elasticsearch') - stackChildren.push(esGroup) - } else { - const esStub = defineGroup({ name: 'es', description: 'Interact with the Elasticsearch API' }) - esStub.alias('elasticsearch') - stackChildren.push(esStub) - } - - if (secondArg == null || kbArgs.has(secondArg)) { - const { registerKbCommandsLazy } = await import('./kb/register.ts') - const kbGroup = await registerKbCommandsLazy() - kbGroup.alias('kibana') - stackChildren.push(kbGroup) +// Register namespaces: load eagerly when first arg matches, otherwise register a lightweight stub. +// To add a new top-level namespace, add an entry to src/namespaces.ts — no changes needed here. +for (const ns of NAMESPACES) { + if (firstArg === ns.name) { + program.addCommand(await ns.load({ version: VERSION, rootProgram: program })) } else { - const kbStub = defineGroup({ name: 'kb', description: 'Interact with the Kibana API' }) - kbStub.alias('kibana') - stackChildren.push(kbStub) + program.addCommand(defineGroup({ name: ns.name, description: ns.description })) } - - program.addCommand(defineGroup( - { name: 'stack', description: 'Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)' }, - ...stackChildren - )) -} else { - program.addCommand(defineGroup({ name: 'stack', description: 'Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)' })) } // Register top-level es|elasticsearch and kb|kibana stubs so they appear in @@ -198,34 +168,6 @@ const kbAlias = defineGroup({ name: 'kb', description: 'Interact with the Kibana kbAlias.alias('kibana') program.addCommand(kbAlias) -if (firstArg === 'cloud') { - const { registerCloudCommands } = await import('./cloud/register.ts') - program.addCommand(registerCloudCommands()) -} else { - program.addCommand(defineGroup({ name: 'cloud', description: 'Manage Elastic Cloud (hosted deployments and serverless projects)' })) -} - -if (firstArg === 'docs') { - const { registerDocsCommands } = await import('./docs/register.ts') - program.addCommand(registerDocsCommands()) -} else { - program.addCommand(defineGroup({ name: 'docs', description: 'Search, read, and ask questions about Elastic documentation' })) -} - -if (firstArg === 'config') { - const { registerConfigCommands } = await import('./config/commands.ts') - program.addCommand(registerConfigCommands()) -} else { - program.addCommand(defineGroup({ name: 'config', description: 'Author and maintain the elastic config file' })) -} - -if (firstArg === 'sanitize') { - const { registerSanitizeCommands } = await import('./sanitize/register.ts') - program.addCommand(registerSanitizeCommands()) -} else { - program.addCommand(defineGroup({ name: 'sanitize', description: 'Sanitize values for safe use in Elasticsearch' })) -} - if (firstArg === 'extension') { const { registerExtensionCommands } = await import('./extension/register.ts') program.addCommand(registerExtensionCommands()) @@ -247,20 +189,12 @@ if (firstArg === 'status') { })) } -if (firstArg === 'cli-schema') { - const { registerCliSchemaCommand } = await import('./cli-schema.ts') - program.addCommand(await registerCliSchemaCommand(VERSION, program)) -} else { - program.addCommand(defineGroup({ name: 'cli-schema', description: 'Emit the CLI structure as argh-schema JSON' })) -} - -// Load config early so --help can hide blocked commands. Skip for commands -// that don't need config (e.g. `version`, `sanitize`, `config` which authors -// the file, and the completion subsystem which runs before any context exists) -// to avoid unnecessary file I/O and a confusing "no config found" path. +// Load config early so --help can hide blocked commands. Skip for commands that don't need +// config (skipConfig namespaces, extension, status, version, or completion commands) to +// avoid unnecessary file I/O and a confusing 'no config found' path. // loadConfig() caches the result in-process; the preAction hook reuses it via the default cache path. const SKIP_EARLY_CONFIG = new Set([ - 'version', 'config', 'sanitize', 'extension', 'status', 'cli-schema', ...COMPLETION_COMMAND_NAMES, + 'version', 'extension', 'status', ...COMPLETION_COMMAND_NAMES, ...skipConfigNames, ]) if (firstArg == null || !SKIP_EARLY_CONFIG.has(firstArg)) { // Parse --profile early (before Commander's full parse) so the early config load diff --git a/src/namespaces.ts b/src/namespaces.ts index 48e05fd..ae0dc38 100644 --- a/src/namespaces.ts +++ b/src/namespaces.ts @@ -3,6 +3,7 @@ * SPDX-License-Identifier: Apache-2.0 */ +import type { Command } from 'commander' import { defineGroup } from './factory.ts' import type { OpaqueCommandHandle } from './factory.ts' @@ -13,6 +14,10 @@ export interface LoadOptions { * Callers that only need CLI startup should use the default (false). */ eager?: boolean + /** CLI version string; forwarded to namespaces that embed version in their output. */ + version?: string + /** Root Commander program; forwarded to namespaces that introspect global options. */ + rootProgram?: Command } /** @@ -25,6 +30,12 @@ export interface LoadOptions { export interface NamespaceEntry { name: string description: string + /** + * When true, the preAction config-load hook and early config load are skipped + * for commands in this namespace. Use for namespaces that don't need a config + * file (e.g. sanitize, cli-schema) or that author the config themselves (config). + */ + skipConfig?: boolean /** Fully load the namespace and return a registered command group handle. */ load: (opts?: LoadOptions) => Promise } @@ -35,7 +46,7 @@ export const NAMESPACES: NamespaceEntry[] = [ description: 'Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)', load: async (opts) => { const eager = opts?.eager === true - const [esModule, { registerKbCommands }] = await Promise.all([ + const [esModule, kbModule] = await Promise.all([ import('./es/register.ts'), import('./kb/register.ts'), ]) @@ -43,7 +54,13 @@ export const NAMESPACES: NamespaceEntry[] = [ ? await esModule.registerEsCommandsEager() : await esModule.registerEsCommandsLazy() esGroup.alias('elasticsearch') - const kbGroup = registerKbCommands() + let kbGroup: OpaqueCommandHandle + if (eager) { + const { loadAllKbApis } = await import('./kb/apis.ts') + kbGroup = kbModule.registerKbCommands(await loadAllKbApis()) + } else { + kbGroup = await kbModule.registerKbCommandsLazy() + } kbGroup.alias('kibana') return defineGroup( { name: 'stack', description: 'Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)' }, @@ -63,6 +80,7 @@ export const NAMESPACES: NamespaceEntry[] = [ { name: 'docs', description: 'Search, read, and ask questions about Elastic documentation', + skipConfig: true, load: async () => { const { registerDocsCommands } = await import('./docs/register.ts') return registerDocsCommands() @@ -71,9 +89,30 @@ export const NAMESPACES: NamespaceEntry[] = [ { name: 'config', description: 'Author and maintain the elastic config file', + skipConfig: true, load: async () => { const { registerConfigCommands } = await import('./config/commands.ts') return registerConfigCommands() }, }, + { + name: 'sanitize', + description: 'Sanitize values for safe use in Elasticsearch', + skipConfig: true, + load: async () => { + const { registerSanitizeCommands } = await import('./sanitize/register.ts') + return registerSanitizeCommands() + }, + }, + { + name: 'cli-schema', + description: 'Emit the CLI structure as argh-schema JSON', + skipConfig: true, + load: async (opts) => { + const { registerCliSchemaCommand } = await import('./cli-schema.ts') + // Exclude cli-schema itself from the eager namespace load to avoid self-reference. + const namespacesForSchema = NAMESPACES.filter(ns => ns.name !== 'cli-schema') + return registerCliSchemaCommand(opts?.version ?? '', opts?.rootProgram, namespacesForSchema) + }, + }, ] From f3d754a48dc866fa8f19827a2a6e7f4f41e3a27c Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Wed, 20 May 2026 11:35:51 +0200 Subject: [PATCH 03/10] feat(schema): align cli-schema emitter with canonical argh-schema spec - Fix `schemaVersion` from string to integer (const `1`) - Rename parameter roles to spec-compliant lowercase (`flag`, `positional`) - Add `dryRun` role for the framework-injected `--dry-run` parameter - Add `integer` and `enum` type values; drop `object` (falls back to `string`) - Filter `elementType` to spec-allowed scalars (string/integer/number/boolean) - Add `CliIntent` (via `CommandIntent` from factory) and emit on leaf commands - Thread `requiresAuth` opt-out from `skipConfig` namespace metadata - Infer `destructive`/`idempotent`/`scope` from HTTP method for ES/KB API commands - Add `intent` to `CommandConfig`, `EsApiDefinition`, `KbApiDefinition` - New `src/cli-schema-intent.ts` with `inferIntentFromHttp` helper - Annotate helper commands (`bulk-ingest`, `scroll-search`, `msearch`, `watch`) - Add `environment` block (3 env vars, 4 config file paths) - Regenerate `docs/cli/schema.json`; validated against cli-schema.meta-schema.json Co-Authored-By: Claude Sonnet 4.6 --- docs/cli/schema.json | 113433 ++++++++++------------------- src/cli-schema-intent.ts | 29 + src/cli-schema.ts | 355 +- src/es/helpers/bulk-ingest.ts | 1 + src/es/helpers/msearch.ts | 3 +- src/es/helpers/scroll-search.ts | 1 + src/es/helpers/watch.ts | 1 + src/es/register.ts | 4 + src/es/types.ts | 3 + src/factory.ts | 17 + src/kb/register.ts | 6 +- src/kb/types.ts | 4 + 12 files changed, 39332 insertions(+), 74525 deletions(-) create mode 100644 src/cli-schema-intent.ts diff --git a/docs/cli/schema.json b/docs/cli/schema.json index 96857fa..51f7302 100644 --- a/docs/cli/schema.json +++ b/docs/cli/schema.json @@ -1,139 +1,129 @@ { - "schemaVersion": "1", + "schemaVersion": 1, "name": "elastic", - "version": "0.1.0-alpha.1", - "description": "Interface with the Elastic Stack and Elastic Cloud from the command line.", + "version": "0.1.1", "reservedMetaCommands": [ "cli-schema" ], "globalOptions": [ { - "role": "Named", + "role": "flag", + "name": "version", + "type": "boolean", + "required": false, + "shortName": "V", + "summary": "Print the Elastic CLI version" + }, + { + "role": "flag", "name": "config-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a config file (default: ~/.elasticrc.yml)", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a config file (default: ~/.elasticrc.yml)" }, { - "role": "Named", + "role": "flag", "name": "use-context", - "shortName": null, "type": "string", "required": false, - "summary": "override the active context from the config file", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "override the active context from the config file" }, { - "role": "Named", + "role": "flag", + "name": "command-profile", + "type": "string", + "required": false, + "summary": "restrict available commands to a deployment profile (serverless, stack, default)" + }, + { + "role": "flag", "name": "json", - "shortName": null, "type": "boolean", "required": false, - "summary": "output as JSON", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "output as JSON" }, { - "role": "Named", + "role": "flag", "name": "output-fields", - "shortName": null, "type": "string", "required": false, - "summary": "comma-separated list of fields to include in output (dot-notation supported)", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "comma-separated list of fields to include in output (dot-notation supported)" }, { - "role": "Named", + "role": "flag", "name": "output-template", - "shortName": null, "type": "string", "required": false, - "summary": "Mustache-like template for custom text output (e.g. \"{{id}}: {{name}}\")", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Mustache-like template for custom text output (e.g. \"{{id}}: {{name}}\")" } ], - "rootDefault": null, + "environment": { + "variables": [ + { + "name": "ELASTIC_CLI_CONFIG_FILE", + "required": false, + "description": "Override the config file path (precedence: --config-file > this > home directory discovery)" + }, + { + "name": "ELASTIC_NO_BANNER", + "required": false, + "description": "Set to 1 to suppress the startup logo" + }, + { + "name": "ELASTIC_CLOUD_ADMIN_API", + "required": false, + "description": "Override the Elastic Cloud admin API base URL" + } + ], + "configFiles": [ + { + "path": "~/.elasticrc.yml", + "required": false, + "description": "Primary config file (recommended)" + }, + { + "path": "~/.elasticrc.yaml", + "required": false, + "description": "Alternative YAML extension" + }, + { + "path": "~/.elasticrc.json", + "required": false, + "description": "JSON form of the config file" + }, + { + "path": "~/.elasticrc", + "required": false, + "description": "Extensionless form of the config file" + } + ] + }, "commands": [ { "path": [], "name": "version", - "summary": "Print the elastic CLI version", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Print the elastic CLI version", + "intent": { + "requiresAuth": false + } } ], "namespaces": [ { "segment": "stack", - "summary": "Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)", - "notes": null, - "options": [], - "defaultCommand": null, "commands": [], "namespaces": [ { "segment": "es", - "summary": "Interact with the Elasticsearch API", - "notes": null, - "options": [], - "defaultCommand": null, "commands": [ { "path": [ @@ -141,954 +131,248 @@ "es" ], "name": "bulk", - "summary": "Bulk index or delete documents.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": false, - "summary": "The name of the data stream, index, or index alias to perform bulk actions on.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The name of the data stream, index, or index alias to perform bulk actions on." }, { - "role": "Named", + "role": "flag", "name": "include-source-on-error", - "shortName": null, "type": "boolean", "required": false, - "summary": "True or false if to include the document source in the error message in case of parsing errors.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "True or false if to include the document source in the error message in case of parsing errors." }, { - "role": "Named", + "role": "flag", "name": "list-executed-pipelines", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the response will include the ingest pipelines that were run for each index or create.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response will include the ingest pipelines that were run for each index or create." }, { - "role": "Named", + "role": "flag", "name": "pipeline", - "shortName": null, "type": "string", "required": false, - "summary": "The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter." }, { - "role": "Named", + "role": "flag", "name": "refresh", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value that is used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source", - "shortName": null, "type": "boolean", "required": false, "summary": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source-excludes", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source-includes", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "timeout", - "shortName": null, "type": "string", "required": false, - "summary": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur." }, { - "role": "Named", + "role": "flag", "name": "wait-for-active-shards", - "shortName": null, "type": "number", "required": false, - "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active." }, { - "role": "Named", + "role": "flag", "name": "require-alias", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request's actions must target an index alias.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request's actions must target an index alias." }, { - "role": "Named", + "role": "flag", "name": "require-data-stream", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request's actions must target a data stream (existing or to be created).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request's actions must target a data stream (existing or to be created)." }, { - "role": "Named", + "role": "flag", "name": "operations", - "shortName": null, "type": "array", - "required": false, - "summary": "", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "clear-scroll", - "summary": "Clear a scrolling search.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", - "name": "scroll-id", - "shortName": null, - "type": "string", - "required": false, - "summary": "The scroll IDs to clear. To clear all scroll IDs, use `_all`.", - "defaultValue": null, - "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "required": false }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Bulk index or delete documents.", + "intent": { + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "close-point-in-time", - "summary": "Close a point in time.", - "notes": null, - "usage": null, - "examples": [], + "name": "create", "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": true, - "summary": "The ID of the point-in-time.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format." }, { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "count", - "summary": "Count search results.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, - "type": "string", - "required": false, - "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "allow-no-indices", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "analyzer", - "shortName": null, - "type": "string", - "required": false, - "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "analyze-wildcard", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "default-operator", - "shortName": null, "type": "string", - "required": false, - "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "df", - "shortName": null, - "type": "string", - "required": false, - "summary": "The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "expand-wildcards", - "shortName": null, - "type": "string", - "required": false, - "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "ignore-throttled", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, concrete, expanded, or aliased indices are ignored when frozen.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "ignore-unavailable", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "lenient", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "min-score", - "shortName": null, - "type": "number", - "required": false, - "summary": "The minimum `_score` value that documents must have to be included in the result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "preference", - "shortName": null, - "type": "string", - "required": false, - "summary": "The node or shard the operation should be performed on. By default, it is random.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "routing", - "shortName": null, - "type": "string", - "required": false, - "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "terminate-after", - "shortName": null, - "type": "number", - "required": false, - "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "q", - "shortName": null, - "type": "string", - "required": false, - "summary": "The query in Lucene query string syntax. This parameter cannot be used with a request body.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "query", - "shortName": null, - "type": "object", - "required": false, - "summary": "Defines the search query using Query DSL. A request body query cannot be used with the `q` query string parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "required": true, + "summary": "The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn’t match a data stream template, this request creates the index." }, { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "create", - "summary": "Create a new document in the index.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", - "name": "id", - "shortName": null, - "type": "string", - "required": true, - "summary": "A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "index", - "shortName": null, - "type": "string", - "required": true, - "summary": "The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn’t match a data stream template, this request creates the index.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "role": "flag", "name": "include-source-on-error", - "shortName": null, "type": "boolean", "required": false, - "summary": "True or false if to include the document source in the error message in case of parsing errors.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "True or false if to include the document source in the error message in case of parsing errors." }, { - "role": "Named", + "role": "flag", "name": "pipeline", - "shortName": null, "type": "string", "required": false, - "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter." }, { - "role": "Named", + "role": "flag", "name": "refresh", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes." }, { - "role": "Named", + "role": "flag", "name": "require-alias", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the destination must be an index alias.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the destination must be an index alias." }, { - "role": "Named", + "role": "flag", "name": "require-data-stream", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request's actions must target a data stream (existing or to be created).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request's actions must target a data stream (existing or to be created)." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value that is used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "timeout", - "shortName": null, "type": "string", "required": false, - "summary": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Elasticsearch waits for at least the specified timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Elasticsearch waits for at least the specified timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur." }, { - "role": "Named", + "role": "flag", "name": "version", - "shortName": null, "type": "number", "required": false, - "summary": "The explicit version number for concurrency control. It must be a non-negative long number.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The explicit version number for concurrency control. It must be a non-negative long number." }, { - "role": "Named", + "role": "flag", "name": "version-type", - "shortName": null, "type": "string", "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The version type." }, { - "role": "Named", + "role": "flag", "name": "wait-for-active-shards", - "shortName": null, "type": "number", "required": false, - "summary": "The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active." }, { - "role": "Named", + "role": "flag", "name": "document", - "shortName": null, - "type": "object", - "required": true, - "summary": "", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "type": "string", + "required": true + }, + { + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Create a new document in the index.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ @@ -1096,206 +380,100 @@ "es" ], "name": "delete", - "summary": "Delete a document.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": true, - "summary": "A unique identifier for the document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "A unique identifier for the document." + }, + { + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": true, - "summary": "The name of the target index.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "The name of the target index." + }, + { + "role": "flag", "name": "if-primary-term", - "shortName": null, "type": "number", "required": false, - "summary": "Only perform the operation if the document has this primary term.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Only perform the operation if the document has this primary term." }, { - "role": "Named", + "role": "flag", "name": "if-seq-no", - "shortName": null, "type": "number", "required": false, - "summary": "Only perform the operation if the document has this sequence number.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Only perform the operation if the document has this sequence number." }, { - "role": "Named", + "role": "flag", "name": "refresh", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "timeout", - "shortName": null, "type": "string", "required": false, - "summary": "The period to wait for active shards. This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs. Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation. By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to wait for active shards. This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs. Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation. By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error." }, { - "role": "Named", + "role": "flag", "name": "version", - "shortName": null, "type": "number", "required": false, - "summary": "An explicit version number for concurrency control. It must match the current version of the document for the request to succeed.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "An explicit version number for concurrency control. It must match the current version of the document for the request to succeed." }, { - "role": "Named", + "role": "flag", "name": "version-type", - "shortName": null, "type": "string", "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The version type." }, { - "role": "Named", + "role": "flag", "name": "wait-for-active-shards", - "shortName": null, "type": "number", "required": false, - "summary": "The minimum number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The minimum number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Delete a document.", + "intent": { + "destructive": true, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ @@ -1303,2755 +481,1624 @@ "es" ], "name": "delete-by-query", - "summary": "Delete documents.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": true, "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "allow-no-indices", - "shortName": null, "type": "boolean", "required": false, - "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." }, { - "role": "Named", + "role": "flag", "name": "analyzer", - "shortName": null, "type": "string", "required": false, - "summary": "Analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "analyze-wildcard", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "conflicts", - "shortName": null, "type": "string", "required": false, - "summary": "What to do if delete by query hits version conflicts: `abort` or `proceed`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "What to do if delete by query hits version conflicts: `abort` or `proceed`." }, { - "role": "Named", + "role": "flag", "name": "default-operator", - "shortName": null, "type": "string", "required": false, - "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "df", - "shortName": null, "type": "string", "required": false, - "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "expand-wildcards", - "shortName": null, "type": "string", "required": false, "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "from", - "shortName": null, "type": "number", "required": false, - "summary": "Skips the specified number of documents.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Skips the specified number of documents." }, { - "role": "Named", + "role": "flag", "name": "ignore-unavailable", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." }, { - "role": "Named", + "role": "flag", "name": "lenient", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "preference", - "shortName": null, "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. It is random by default.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The node or shard the operation should be performed on. It is random by default." }, { - "role": "Named", + "role": "flag", "name": "refresh", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. This is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed. Unlike the delete API, it does not support `wait_for`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. This is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed. Unlike the delete API, it does not support `wait_for`." }, { - "role": "Named", + "role": "flag", "name": "request-cache", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request cache is used for this request. Defaults to the index-level setting.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request cache is used for this request. Defaults to the index-level setting." }, { - "role": "Named", + "role": "flag", "name": "requests-per-second", - "shortName": null, "type": "number", "required": false, - "summary": "The throttle for this request in sub-requests per second.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The throttle for this request in sub-requests per second." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "q", - "shortName": null, "type": "string", "required": false, - "summary": "A query in the Lucene query string syntax.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A query in the Lucene query string syntax." }, { - "role": "Named", + "role": "flag", "name": "scroll", - "shortName": null, "type": "string", "required": false, - "summary": "The period to retain the search context for scrolling.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to retain the search context for scrolling." }, { - "role": "Named", + "role": "flag", "name": "scroll-size", - "shortName": null, "type": "number", "required": false, - "summary": "The size of the scroll request that powers the operation.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The size of the scroll request that powers the operation." }, { - "role": "Named", + "role": "flag", "name": "search-timeout", - "shortName": null, "type": "string", "required": false, - "summary": "The explicit timeout for each search request. It defaults to no timeout.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The explicit timeout for each search request. It defaults to no timeout." }, { - "role": "Named", + "role": "flag", "name": "search-type", - "shortName": null, "type": "string", "required": false, - "summary": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`." }, { - "role": "Named", + "role": "flag", "name": "slices", - "shortName": null, "type": "number", "required": false, - "summary": "The number of slices this task should be divided into.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of slices this task should be divided into." }, { - "role": "Named", + "role": "flag", "name": "stats", - "shortName": null, "type": "array", "required": false, - "summary": "The specific `tag` of the request for logging and statistical purposes.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The specific `tag` of the request for logging and statistical purposes." }, { - "role": "Named", + "role": "flag", "name": "terminate-after", - "shortName": null, "type": "number", "required": false, - "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers." }, { - "role": "Named", + "role": "flag", "name": "timeout", - "shortName": null, "type": "string", "required": false, - "summary": "The period each deletion request waits for active shards.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period each deletion request waits for active shards." }, { - "role": "Named", + "role": "flag", "name": "version", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, returns the document version as part of a hit.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, returns the document version as part of a hit." }, { - "role": "Named", + "role": "flag", "name": "wait-for-active-shards", - "shortName": null, "type": "number", "required": false, - "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` value controls how long each write request waits for unavailable shards to become available.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` value controls how long each write request waits for unavailable shards to become available." }, { - "role": "Named", + "role": "flag", "name": "wait-for-completion", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/{taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/{taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space." }, { - "role": "Named", + "role": "flag", "name": "max-docs", - "shortName": null, "type": "number", "required": false, - "summary": "The maximum number of documents to delete.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The maximum number of documents to delete." }, { - "role": "Named", + "role": "flag", "name": "query", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "The documents to delete specified with Query DSL.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The documents to delete specified with Query DSL." }, { - "role": "Named", + "role": "flag", "name": "slice", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Slice the request manually using the provided slice ID and total number of slices.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Slice the request manually using the provided slice ID and total number of slices." }, { - "role": "Named", + "role": "flag", "name": "sort", - "shortName": null, "type": "string", "required": false, "summary": "A sort object that specifies the order of deleted documents.", - "defaultValue": null, "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "separator": "," }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Delete documents.", + "intent": { + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "delete-script", - "summary": "Delete a script or search template.", - "notes": null, - "usage": null, - "examples": [], + "name": "exists", "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": true, - "summary": "The identifier for the stored script or search template.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "master-timeout", - "shortName": null, + "summary": "A unique document identifier." + }, + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`)." + }, + { + "role": "flag", + "name": "preference", "type": "string", "required": false, - "summary": "The 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. It can also be set to `-1` to indicate that the request should never timeout.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with \"jumping values\" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name." }, { - "role": "Named", - "name": "timeout", - "shortName": null, + "role": "flag", + "name": "realtime", + "type": "boolean", + "required": false, + "summary": "If `true`, the request is real-time as opposed to near-real-time." + }, + { + "role": "flag", + "name": "refresh", + "type": "boolean", + "required": false, + "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing)." + }, + { + "role": "flag", + "name": "routing", + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "repeatable": true + }, + { + "role": "flag", + "name": "source", + "type": "boolean", + "required": false, + "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "repeatable": true + }, + { + "role": "flag", + "name": "source-excludes", + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "repeatable": true + }, + { + "role": "flag", + "name": "source-includes", + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "repeatable": true + }, + { + "role": "flag", + "name": "stored-fields", "type": "string", "required": false, - "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`.", + "repeatable": true + }, + { + "role": "flag", + "name": "version", + "type": "number", + "required": false, + "summary": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed." + }, + { + "role": "flag", + "name": "version-type", + "type": "string", + "required": false, + "summary": "The version type." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Check a document.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "exists", - "summary": "Check a document.", - "notes": null, - "usage": null, - "examples": [], + "name": "exists-source", "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": true, - "summary": "A unique document identifier.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "A unique identifier for the document." + }, + { + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": true, - "summary": "A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`)." + }, + { + "role": "flag", "name": "preference", - "shortName": null, "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with \"jumping values\" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas." }, { - "role": "Named", + "role": "flag", "name": "realtime", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request is real-time as opposed to near-real-time.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request is real-time as opposed to near-real-time." }, { - "role": "Named", + "role": "flag", "name": "refresh", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing)." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source", - "shortName": null, "type": "boolean", "required": false, "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true + }, + { + "role": "flag", + "name": "source-excludes", + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude in the response.", + "repeatable": true + }, + { + "role": "flag", + "name": "source-includes", + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response.", + "repeatable": true + }, + { + "role": "flag", + "name": "version", + "type": "number", + "required": false, + "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed." + }, + { + "role": "flag", + "name": "version-type", + "type": "string", + "required": false, + "summary": "The version type." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Check for a document source.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "get", + "parameters": [ + { + "role": "flag", + "name": "id", + "type": "string", + "required": true, + "summary": "A unique document identifier." + }, + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "The name of the index that contains the document." + }, + { + "role": "flag", + "name": "preference", + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with \"jumping values\" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name." + }, + { + "role": "flag", + "name": "realtime", + "type": "boolean", + "required": false, + "summary": "If `true`, the request is real-time as opposed to near-real-time." + }, + { + "role": "flag", + "name": "refresh", + "type": "boolean", + "required": false, + "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing)." }, { - "role": "Named", + "role": "flag", + "name": "routing", + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "repeatable": true + }, + { + "role": "flag", + "name": "source", + "type": "boolean", + "required": false, + "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "repeatable": true + }, + { + "role": "flag", "name": "source-excludes", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", + "name": "source-exclude-vectors", + "type": "boolean", + "required": false, + "summary": "Whether vectors should be excluded from _source" + }, + { + "role": "flag", "name": "source-includes", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "stored-fields", - "shortName": null, "type": "string", "required": false, - "summary": "A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. Only leaf fields can be retrieved with the `stored_fields` option. Object fields can't be returned; if specified, the request fails.", + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "version", - "shortName": null, "type": "number", "required": false, - "summary": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed." }, { - "role": "Named", + "role": "flag", "name": "version-type", - "shortName": null, "type": "string", "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The version type." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Get a document by its ID.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "exists-source", - "summary": "Check for a document source.", - "notes": null, - "usage": null, - "examples": [], + "name": "get-source", "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": true, - "summary": "A unique identifier for the document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "A unique document identifier." + }, + { + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": true, - "summary": "A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "The name of the index that contains the document." + }, + { + "role": "flag", "name": "preference", - "shortName": null, "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas." }, { - "role": "Named", + "role": "flag", "name": "realtime", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request is real-time as opposed to near-real-time.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request is real-time as opposed to near-real-time." }, { - "role": "Named", + "role": "flag", "name": "refresh", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing)." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source", - "shortName": null, "type": "boolean", "required": false, "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source-excludes", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of source fields to exclude in the response.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source-includes", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of source fields to include in the response.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "version", - "shortName": null, "type": "number", "required": false, - "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed." }, { - "role": "Named", + "role": "flag", "name": "version-type", - "shortName": null, "type": "string", "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The version type." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Get a document's source.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "explain", - "summary": "Explain a document match result.", - "notes": null, - "usage": null, - "examples": [], + "name": "index", "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", - "required": true, - "summary": "The document identifier.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "required": false, + "summary": "A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter." + }, + { + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": true, - "summary": "Index names that are used to limit the request. Only a single index name can be provided to this parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "analyzer", - "shortName": null, - "type": "string", + "summary": "The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index. You can check for existing targets with the resolve index API." + }, + { + "role": "flag", + "name": "if-primary-term", + "type": "number", "required": false, - "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Only perform the operation if the document has this primary term." }, { - "role": "Named", - "name": "analyze-wildcard", - "shortName": null, + "role": "flag", + "name": "if-seq-no", + "type": "number", + "required": false, + "summary": "Only perform the operation if the document has this sequence number." + }, + { + "role": "flag", + "name": "include-source-on-error", "type": "boolean", "required": false, - "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "True or false if to include the document source in the error message in case of parsing errors." }, { - "role": "Named", - "name": "default-operator", - "shortName": null, + "role": "flag", + "name": "op-type", "type": "string", "required": false, - "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required." }, { - "role": "Named", - "name": "df", - "shortName": null, + "role": "flag", + "name": "pipeline", "type": "string", "required": false, - "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter." }, { - "role": "Named", - "name": "lenient", - "shortName": null, + "role": "flag", + "name": "refresh", "type": "boolean", "required": false, - "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes." }, { - "role": "Named", - "name": "preference", - "shortName": null, + "role": "flag", + "name": "routing", "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. It is random by default.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A custom value that is used to route operations to a specific shard.", + "repeatable": true }, { - "role": "Named", - "name": "routing", - "shortName": null, + "role": "flag", + "name": "timeout", "type": "string", "required": false, - "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur." }, { - "role": "Named", - "name": "source", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "version", + "type": "number", "required": false, - "summary": "`True` or `false` to return the `_source` field or not or a list of fields to return.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "An explicit version number for concurrency control. It must be a non-negative long number." }, { - "role": "Named", - "name": "source-excludes", - "shortName": null, + "role": "flag", + "name": "version-type", "type": "string", "required": false, - "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The version type." }, { - "role": "Named", - "name": "source-includes", - "shortName": null, - "type": "string", + "role": "flag", + "name": "wait-for-active-shards", + "type": "number", "required": false, - "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active." }, { - "role": "Named", - "name": "stored-fields", - "shortName": null, - "type": "string", + "role": "flag", + "name": "require-alias", + "type": "boolean", "required": false, - "summary": "A comma-separated list of stored fields to return in the response.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the destination must be an index alias." }, { - "role": "Named", - "name": "q", - "shortName": null, - "type": "string", + "role": "flag", + "name": "require-data-stream", + "type": "boolean", "required": false, - "summary": "The query in the Lucene query string syntax.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request's actions must target a data stream (existing or to be created)." }, { - "role": "Named", - "name": "query", - "shortName": null, - "type": "object", - "required": false, - "summary": "Defines the search definition using the Query DSL.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "role": "flag", + "name": "document", + "type": "string", + "required": true }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Create or update a document in an index.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "field-caps", - "summary": "Get the field capabilities.", - "notes": null, - "usage": null, - "examples": [], + "name": "mget", "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": false, - "summary": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "allow-no-indices", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index." }, { - "role": "Named", - "name": "expand-wildcards", - "shortName": null, + "role": "flag", + "name": "preference", "type": "string", "required": false, - "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Specifies the node or shard the operation should be performed on. Random by default." }, { - "role": "Named", - "name": "ignore-unavailable", - "shortName": null, + "role": "flag", + "name": "realtime", "type": "boolean", "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request is real-time as opposed to near-real-time." }, { - "role": "Named", - "name": "include-unmapped", - "shortName": null, + "role": "flag", + "name": "refresh", "type": "boolean", "required": false, - "summary": "If true, unmapped fields are included in the response.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request refreshes relevant shards before retrieving documents." }, { - "role": "Named", - "name": "filters", - "shortName": null, + "role": "flag", + "name": "routing", "type": "string", "required": false, - "summary": "A comma-separated list of filters to apply to the response.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Custom value used to route operations to a specific shard.", + "repeatable": true }, { - "role": "Named", - "name": "types", - "shortName": null, - "type": "array", + "role": "flag", + "name": "source", + "type": "boolean", "required": false, - "summary": "A comma-separated list of field types to include. Any fields that do not match one of these types will be excluded from the results. It defaults to empty, meaning that all field types are returned.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "True or false to return the `_source` field or not, or a list of fields to return.", + "repeatable": true }, { - "role": "Named", - "name": "include-empty-fields", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "source-excludes", + "type": "string", "required": false, - "summary": "If false, empty fields are not included in the response.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.", + "repeatable": true }, { - "role": "Named", - "name": "fields", - "shortName": null, + "role": "flag", + "name": "source-includes", "type": "string", "required": false, - "summary": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", - "defaultValue": null, - "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "repeatable": true }, { - "role": "Named", - "name": "index-filter", - "shortName": null, - "type": "object", + "role": "flag", + "name": "stored-fields", + "type": "string", "required": false, - "summary": "Filter indices if the provided query rewrites to `match_none` on every shard. IMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request. For instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range. However, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", + "repeatable": true }, { - "role": "Named", - "name": "runtime-mappings", - "shortName": null, - "type": "object", + "role": "flag", + "name": "docs", + "type": "array", + "required": false, + "summary": "The documents you want to retrieve. Required if no index is specified in the request URI." + }, + { + "role": "flag", + "name": "ids", + "type": "string", "required": false, - "summary": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", + "repeatable": true, + "separator": "," }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Get multiple documents.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "get", - "summary": "Get a document by its ID.", - "notes": null, - "usage": null, - "examples": [], + "name": "reindex", "parameters": [ { - "role": "Named", - "name": "id", - "shortName": null, - "type": "string", - "required": true, - "summary": "A unique document identifier.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "index", - "shortName": null, - "type": "string", - "required": true, - "summary": "The name of the index that contains the document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "preference", - "shortName": null, - "type": "string", + "role": "flag", + "name": "refresh", + "type": "boolean", "required": false, - "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with \"jumping values\" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request refreshes affected shards to make this operation visible to search." }, { - "role": "Named", - "name": "realtime", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "requests-per-second", + "type": "number", "required": false, - "summary": "If `true`, the request is real-time as opposed to near-real-time.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The throttle for this request in sub-requests per second. By default, there is no throttle." }, { - "role": "Named", - "name": "refresh", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "scroll", + "type": "string", "required": false, - "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period of time that a consistent view of the index should be maintained for scrolled search." }, { - "role": "Named", - "name": "routing", - "shortName": null, + "role": "flag", + "name": "slices", + "type": "number", + "required": false, + "summary": "The number of slices this task should be divided into. It defaults to one slice, which means the task isn't sliced into subtasks. Reindex supports sliced scroll to parallelize the reindexing process. This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts. NOTE: Reindexing from remote clusters does not support manual or automatic slicing. If set to `auto`, Elasticsearch chooses the number of slices to use. This setting will use one slice per shard, up to a certain limit. If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards." + }, + { + "role": "flag", + "name": "timeout", "type": "string", "required": false, - "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. By default, Elasticsearch waits for at least one minute before failing. The actual wait time could be longer, particularly when multiple waits occur." }, { - "role": "Named", - "name": "source", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "wait-for-active-shards", + "type": "number", "required": false, - "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of shard copies that must be active before proceeding with the operation. Set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value is one, which means it waits for each primary shard to be active." }, { - "role": "Named", - "name": "source-excludes", - "shortName": null, - "type": "string", + "role": "flag", + "name": "wait-for-completion", + "type": "boolean", "required": false, - "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request blocks until the operation is complete." }, { - "role": "Named", - "name": "source-exclude-vectors", - "shortName": null, + "role": "flag", + "name": "require-alias", "type": "boolean", "required": false, - "summary": "Whether vectors should be excluded from _source", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the destination must be an index alias." }, { - "role": "Named", - "name": "source-includes", - "shortName": null, + "role": "flag", + "name": "conflicts", "type": "string", "required": false, - "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Indicates whether to continue reindexing even when there are conflicts." }, { - "role": "Named", - "name": "stored-fields", - "shortName": null, + "role": "flag", + "name": "dest", "type": "string", - "required": false, - "summary": "A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. Only leaf fields can be retrieved with the `stored_fields` option. Object fields can't be returned; if specified, the request fails.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "required": true, + "summary": "The destination you are copying to." }, { - "role": "Named", - "name": "version", - "shortName": null, + "role": "flag", + "name": "max-docs", "type": "number", "required": false, - "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The maximum number of documents to reindex. By default, all documents are reindexed. If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation. If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query." }, { - "role": "Named", - "name": "version-type", - "shortName": null, + "role": "flag", + "name": "script", "type": "string", "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The script to run to update the document source or metadata when reindexing." + }, + { + "role": "flag", + "name": "source", + "type": "string", + "required": true, + "summary": "The source you are copying from." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Reindex documents.", + "intent": { + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "get-script", - "summary": "Get a script or search template.", - "notes": null, - "usage": null, - "examples": [], + "name": "update", "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": true, - "summary": "The identifier for the stored script or search template.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "master-timeout", - "shortName": null, + "summary": "A unique identifier for the document to be updated." + }, + { + "role": "flag", + "name": "index", "type": "string", + "required": true, + "summary": "The name of the target index. By default, the index is created automatically if it doesn't exist." + }, + { + "role": "flag", + "name": "if-primary-term", + "type": "number", "required": false, - "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Only perform the operation if the document has this primary term." }, { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", + "role": "flag", + "name": "if-seq-no", + "type": "number", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Only perform the operation if the document has this sequence number." }, { - "role": "Named", - "name": "dry-run", - "shortName": null, + "role": "flag", + "name": "include-source-on-error", "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "get-source", - "summary": "Get a document's source.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ + "summary": "True or false if to include the document source in the error message in case of parsing errors." + }, { - "role": "Named", - "name": "id", - "shortName": null, - "type": "string", - "required": true, - "summary": "A unique document identifier.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "index", - "shortName": null, - "type": "string", - "required": true, - "summary": "The name of the index that contains the document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "preference", - "shortName": null, + "role": "flag", + "name": "lang", "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The script language." }, { - "role": "Named", - "name": "realtime", - "shortName": null, + "role": "flag", + "name": "refresh", "type": "boolean", "required": false, - "summary": "If `true`, the request is real-time as opposed to near-real-time.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes." }, { - "role": "Named", - "name": "refresh", - "shortName": null, + "role": "flag", + "name": "require-alias", "type": "boolean", "required": false, - "summary": "If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the destination must be an index alias." + }, + { + "role": "flag", + "name": "retry-on-conflict", + "type": "number", + "required": false, + "summary": "The number of times the operation should be retried when a conflict occurs." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", - "name": "source", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "timeout", + "type": "string", "required": false, - "summary": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur." }, { - "role": "Named", + "role": "flag", + "name": "wait-for-active-shards", + "type": "number", + "required": false, + "summary": "The number of copies of each shard that must be active before proceeding with the operation. Set to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1). The default value of `1` means it waits for each primary shard to be active." + }, + { + "role": "flag", "name": "source-excludes", - "shortName": null, "type": "string", "required": false, - "summary": "A comma-separated list of source fields to exclude in the response.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The source fields you want to exclude.", + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source-includes", - "shortName": null, "type": "string", "required": false, - "summary": "A comma-separated list of source fields to include in the response.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The source fields you want to retrieve.", + "repeatable": true }, { - "role": "Named", - "name": "version", - "shortName": null, - "type": "number", + "role": "flag", + "name": "detect-noop", + "type": "boolean", "required": false, - "summary": "The version number for concurrency control. It must match the current version of the document for the request to succeed.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document." }, { - "role": "Named", - "name": "version-type", - "shortName": null, + "role": "flag", + "name": "doc", + "type": "string", + "required": false, + "summary": "A partial update to an existing document. If both `doc` and `script` are specified, `doc` is ignored." + }, + { + "role": "flag", + "name": "doc-as-upsert", + "type": "boolean", + "required": false, + "summary": "If `true`, use the contents of 'doc' as the value of 'upsert'. NOTE: Using ingest pipelines with `doc_as_upsert` is not supported." + }, + { + "role": "flag", + "name": "script", + "type": "string", + "required": false, + "summary": "The script to run to update the document." + }, + { + "role": "flag", + "name": "scripted-upsert", + "type": "boolean", + "required": false, + "summary": "If `true`, run the script whether or not the document exists." + }, + { + "role": "flag", + "name": "source", + "type": "boolean", + "required": false, + "summary": "If `false`, turn off source retrieval. You can also specify a comma-separated list of the fields you want to retrieve." + }, + { + "role": "flag", + "name": "upsert", "type": "string", "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is run." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Update a document.", + "intent": { + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "index", - "summary": "Create or update a document in an index.", - "notes": null, - "usage": null, - "examples": [], + "name": "update-by-query", "parameters": [ { - "role": "Named", - "name": "id", - "shortName": null, + "role": "flag", + "name": "index", "type": "string", + "required": true, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "allow-no-indices", + "type": "boolean", "required": false, - "summary": "A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." }, { - "role": "Named", - "name": "index", - "shortName": null, + "role": "flag", + "name": "analyzer", "type": "string", - "required": true, - "summary": "The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index. You can check for existing targets with the resolve index API.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "if-primary-term", - "shortName": null, - "type": "number", "required": false, - "summary": "Only perform the operation if the document has this primary term.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", - "name": "if-seq-no", - "shortName": null, + "role": "flag", + "name": "analyze-wildcard", + "type": "boolean", + "required": false, + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified." + }, + { + "role": "flag", + "name": "default-operator", + "type": "string", + "required": false, + "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified." + }, + { + "role": "flag", + "name": "df", + "type": "string", + "required": false, + "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified." + }, + { + "role": "flag", + "name": "expand-wildcards", + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "repeatable": true + }, + { + "role": "flag", + "name": "from", "type": "number", "required": false, - "summary": "Only perform the operation if the document has this sequence number.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Skips the specified number of documents." }, { - "role": "Named", - "name": "include-source-on-error", - "shortName": null, + "role": "flag", + "name": "ignore-unavailable", "type": "boolean", "required": false, - "summary": "True or false if to include the document source in the error message in case of parsing errors.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." }, { - "role": "Named", - "name": "op-type", - "shortName": null, - "type": "string", + "role": "flag", + "name": "lenient", + "type": "boolean", "required": false, - "summary": "Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "pipeline", - "shortName": null, "type": "string", "required": false, - "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter." }, { - "role": "Named", + "role": "flag", + "name": "preference", + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default." + }, + { + "role": "flag", + "name": "q", + "type": "string", + "required": false, + "summary": "A query in the Lucene query string syntax." + }, + { + "role": "flag", "name": "refresh", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes. This is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed." + }, + { + "role": "flag", + "name": "request-cache", + "type": "boolean", + "required": false, + "summary": "If `true`, the request cache is used for this request. It defaults to the index-level setting." + }, + { + "role": "flag", + "name": "requests-per-second", + "type": "number", + "required": false, + "summary": "The throttle for this request in sub-requests per second." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, - "summary": "A custom value that is used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A custom value used to route operations to a specific shard.", + "repeatable": true }, { - "role": "Named", - "name": "timeout", - "shortName": null, + "role": "flag", + "name": "scroll", "type": "string", "required": false, - "summary": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to retain the search context for scrolling." }, { - "role": "Named", - "name": "version", - "shortName": null, + "role": "flag", + "name": "scroll-size", "type": "number", "required": false, - "summary": "An explicit version number for concurrency control. It must be a non-negative long number.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The size of the scroll request that powers the operation." }, { - "role": "Named", - "name": "version-type", - "shortName": null, + "role": "flag", + "name": "search-timeout", "type": "string", "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "An explicit timeout for each search request. By default, there is no timeout." }, { - "role": "Named", - "name": "wait-for-active-shards", - "shortName": null, - "type": "number", + "role": "flag", + "name": "search-type", + "type": "string", "required": false, - "summary": "The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`." }, { - "role": "Named", - "name": "require-alias", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "slices", + "type": "number", "required": false, - "summary": "If `true`, the destination must be an index alias.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of slices this task should be divided into." }, { - "role": "Named", - "name": "require-data-stream", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "sort", + "type": "array", "required": false, - "summary": "If `true`, the request's actions must target a data stream (existing or to be created).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list of : pairs." }, { - "role": "Named", - "name": "document", - "shortName": null, - "type": "object", - "required": true, - "summary": "", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", + "role": "flag", + "name": "stats", + "type": "array", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The specific `tag` of the request for logging and statistical purposes." }, { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "terminate-after", + "type": "number", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "info", - "summary": "Get cluster info.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ + "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers." + }, { - "role": "Named", - "name": "input-file", - "shortName": null, + "role": "flag", + "name": "timeout", "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. By default, it is one minute. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur." }, { - "role": "Named", - "name": "dry-run", - "shortName": null, + "role": "flag", + "name": "version", "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "mget", - "summary": "Get multiple documents.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ + "summary": "If `true`, returns the document version as part of a hit." + }, { - "role": "Named", - "name": "index", - "shortName": null, - "type": "string", + "role": "flag", + "name": "version-type", + "type": "boolean", "required": false, - "summary": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Should the document increment the version number (internal) on hit or not (reindex)" }, { - "role": "Named", - "name": "preference", - "shortName": null, - "type": "string", + "role": "flag", + "name": "wait-for-active-shards", + "type": "number", "required": false, - "summary": "Specifies the node or shard the operation should be performed on. Random by default.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` parameter controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the bulk API." }, { - "role": "Named", - "name": "realtime", - "shortName": null, + "role": "flag", + "name": "wait-for-completion", "type": "boolean", "required": false, - "summary": "If `true`, the request is real-time as opposed to near-real-time.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/{taskId}`." }, { - "role": "Named", - "name": "refresh", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "max-docs", + "type": "number", "required": false, - "summary": "If `true`, the request refreshes relevant shards before retrieving documents.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The maximum number of documents to update." }, { - "role": "Named", - "name": "routing", - "shortName": null, + "role": "flag", + "name": "query", "type": "string", "required": false, - "summary": "Custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The documents to update using the Query DSL." }, { - "role": "Named", - "name": "source", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "script", + "type": "string", "required": false, - "summary": "True or false to return the `_source` field or not, or a list of fields to return.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The script to run to update the document source or metadata when updating." }, { - "role": "Named", - "name": "source-excludes", - "shortName": null, + "role": "flag", + "name": "slice", "type": "string", "required": false, - "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Slice the request manually using the provided slice ID and total number of slices." }, { - "role": "Named", - "name": "source-includes", - "shortName": null, + "role": "flag", + "name": "conflicts", "type": "string", "required": false, - "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`." }, { - "role": "Named", - "name": "stored-fields", - "shortName": null, + "role": "flag", + "name": "input-file", "type": "string", "required": false, - "summary": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "docs", - "shortName": null, - "type": "array", + "role": "dryRun", + "name": "dry-run", + "type": "boolean", "required": false, - "summary": "The documents you want to retrieve. Required if no index is specified in the request URI.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Update documents.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "clear-scroll", + "parameters": [ { - "role": "Named", - "name": "ids", - "shortName": null, + "role": "flag", + "name": "scroll-id", "type": "string", "required": false, - "summary": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", - "defaultValue": null, + "summary": "The scroll IDs to clear. To clear all scroll IDs, use `_all`.", "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "separator": "," + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Clear a scrolling search.", + "intent": { + "destructive": true, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "close-point-in-time", + "parameters": [ + { + "role": "flag", + "name": "id", + "type": "string", + "required": true, + "summary": "The ID of the point-in-time." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Close a point in time.", + "intent": { + "destructive": true, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ @@ -4059,286 +2106,136 @@ "es" ], "name": "msearch", - "summary": "Run multiple searches.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": false, "summary": "Comma-separated list of data streams, indices, and index aliases to search.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "allow-no-indices", - "shortName": null, "type": "boolean", "required": false, - "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." }, { - "role": "Named", + "role": "flag", "name": "ccs-minimize-roundtrips", - "shortName": null, "type": "boolean", "required": false, - "summary": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests." }, { - "role": "Named", + "role": "flag", "name": "expand-wildcards", - "shortName": null, "type": "string", "required": false, "summary": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "ignore-throttled", - "shortName": null, "type": "boolean", "required": false, - "summary": "If true, concrete, expanded or aliased indices are ignored when frozen.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If true, concrete, expanded or aliased indices are ignored when frozen." }, { - "role": "Named", + "role": "flag", "name": "ignore-unavailable", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." }, { - "role": "Named", + "role": "flag", "name": "include-named-queries-score", - "shortName": null, "type": "boolean", "required": false, - "summary": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead." }, { - "role": "Named", + "role": "flag", "name": "max-concurrent-searches", - "shortName": null, "type": "number", "required": false, - "summary": "Maximum number of concurrent searches the multi search API can execute. Defaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Maximum number of concurrent searches the multi search API can execute. Defaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`." }, { - "role": "Named", + "role": "flag", "name": "max-concurrent-shard-requests", - "shortName": null, "type": "number", "required": false, - "summary": "Maximum number of concurrent shard requests that each sub-search request executes per node.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Maximum number of concurrent shard requests that each sub-search request executes per node." }, { - "role": "Named", + "role": "flag", "name": "pre-filter-shard-size", - "shortName": null, "type": "number", "required": false, - "summary": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint." }, { - "role": "Named", + "role": "flag", "name": "rest-total-hits-as-int", - "shortName": null, "type": "boolean", "required": false, - "summary": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "Custom routing value used to route search operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "search-type", - "shortName": null, "type": "string", "required": false, - "summary": "Indicates whether global term and document frequencies should be used when scoring returned documents.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Indicates whether global term and document frequencies should be used when scoring returned documents." }, { - "role": "Named", + "role": "flag", "name": "typed-keys", - "shortName": null, "type": "boolean", "required": false, - "summary": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response." }, { - "role": "Named", + "role": "flag", "name": "searches", - "shortName": null, "type": "array", - "required": false, - "summary": "", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "required": false }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Run multiple searches.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ @@ -4346,1208 +2243,171 @@ "es" ], "name": "msearch-template", - "summary": "Run multiple templated searches.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "ccs-minimize-roundtrips", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, network round-trips are minimized for cross-cluster search requests.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, network round-trips are minimized for cross-cluster search requests." }, { - "role": "Named", + "role": "flag", "name": "max-concurrent-searches", - "shortName": null, "type": "number", "required": false, - "summary": "The maximum number of concurrent searches the API can run.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The maximum number of concurrent searches the API can run." }, { - "role": "Named", + "role": "flag", "name": "search-type", - "shortName": null, "type": "string", "required": false, - "summary": "The type of the search operation.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The type of the search operation." }, { - "role": "Named", + "role": "flag", "name": "rest-total-hits-as-int", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object." }, { - "role": "Named", + "role": "flag", "name": "typed-keys", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the response prefixes aggregation and suggester names with their respective types.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response prefixes aggregation and suggester names with their respective types." }, { - "role": "Named", + "role": "flag", "name": "search-templates", - "shortName": null, "type": "array", - "required": false, - "summary": "", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "required": false }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Run multiple templated searches.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "mtermvectors", - "summary": "Get multiple term vectors.", - "notes": null, - "usage": null, - "examples": [], + "name": "open-point-in-time", "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, - "type": "string", - "required": false, - "summary": "The name of the index that contains the documents.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "fields", - "shortName": null, - "type": "string", - "required": false, - "summary": "A comma-separated list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "field-statistics", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "offsets", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, the response includes term offsets.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "payloads", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, the response includes term payloads.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "positions", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, the response includes term positions.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "preference", - "shortName": null, - "type": "string", - "required": false, - "summary": "The node or shard the operation should be performed on. It is random by default.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "realtime", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If true, the request is real-time as opposed to near-real-time.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "routing", - "shortName": null, - "type": "string", - "required": false, - "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "term-statistics", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If true, the response includes term frequency and document frequency.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "version", - "shortName": null, - "type": "number", - "required": false, - "summary": "If `true`, returns the document version as part of a hit.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "version-type", - "shortName": null, - "type": "string", - "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "docs", - "shortName": null, - "type": "array", - "required": false, - "summary": "An array of existing or artificial documents.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "ids", - "shortName": null, - "type": "array", - "required": false, - "summary": "A simplified syntax to specify documents by their ID if they're in the same index.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "open-point-in-time", - "summary": "Open a point in time.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", - "name": "index", - "shortName": null, "type": "string", "required": true, "summary": "A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "keep-alive", - "shortName": null, "type": "string", "required": true, - "summary": "Extend the length of time that the point in time persists.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "Extend the length of time that the point in time persists." + }, + { + "role": "flag", "name": "ignore-unavailable", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." }, { - "role": "Named", + "role": "flag", "name": "preference", - "shortName": null, "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. By default, it is random.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The node or shard the operation should be performed on. By default, it is random." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value that is used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "expand-wildcards", - "shortName": null, "type": "string", "required": false, "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "allow-partial-search-results", - "shortName": null, "type": "boolean", "required": false, - "summary": "Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. If `true`, the point in time will contain all the shards that are available at the time of the request.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. If `true`, the point in time will contain all the shards that are available at the time of the request." }, { - "role": "Named", + "role": "flag", "name": "max-concurrent-shard-requests", - "shortName": null, "type": "number", "required": false, - "summary": "Maximum number of concurrent shard requests that each sub-search request executes per node.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Maximum number of concurrent shard requests that each sub-search request executes per node." }, { - "role": "Named", + "role": "flag", "name": "index-filter", - "shortName": null, - "type": "object", - "required": false, - "summary": "Filter indices if the provided query rewrites to `match_none` on every shard.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "ping", - "summary": "Ping the cluster.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "put-script", - "summary": "Create or update a script or search template.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", - "name": "id", - "shortName": null, - "type": "string", - "required": true, - "summary": "The identifier for the stored script or search template. It must be unique within the cluster.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "context", - "shortName": null, - "type": "string", - "required": false, - "summary": "The context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "master-timeout", - "shortName": null, - "type": "string", - "required": false, - "summary": "The 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. It can also be set to `-1` to indicate that the request should never timeout.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "timeout", - "shortName": null, - "type": "string", - "required": false, - "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "script", - "shortName": null, - "type": "object", - "required": true, - "summary": "The script or search template, its parameters, and its language.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "rank-eval", - "summary": "Evaluate ranked search results.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", - "name": "index", - "shortName": null, - "type": "string", - "required": false, - "summary": "A comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "allow-no-indices", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "expand-wildcards", - "shortName": null, - "type": "string", - "required": false, - "summary": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "ignore-unavailable", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "search-type", - "shortName": null, - "type": "string", - "required": false, - "summary": "Search operation type", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "requests", - "shortName": null, - "type": "array", - "required": true, - "summary": "A set of typical search requests, together with their provided ratings.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": "object", - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "metric", - "shortName": null, - "type": "object", - "required": false, - "summary": "Definition of the evaluation metric to calculate.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "reindex", - "summary": "Reindex documents.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", - "name": "refresh", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, the request refreshes affected shards to make this operation visible to search.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "requests-per-second", - "shortName": null, - "type": "number", - "required": false, - "summary": "The throttle for this request in sub-requests per second. By default, there is no throttle.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "scroll", - "shortName": null, - "type": "string", - "required": false, - "summary": "The period of time that a consistent view of the index should be maintained for scrolled search.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "slices", - "shortName": null, - "type": "number", - "required": false, - "summary": "The number of slices this task should be divided into. It defaults to one slice, which means the task isn't sliced into subtasks. Reindex supports sliced scroll to parallelize the reindexing process. This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts. NOTE: Reindexing from remote clusters does not support manual or automatic slicing. If set to `auto`, Elasticsearch chooses the number of slices to use. This setting will use one slice per shard, up to a certain limit. If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "timeout", - "shortName": null, - "type": "string", - "required": false, - "summary": "The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. By default, Elasticsearch waits for at least one minute before failing. The actual wait time could be longer, particularly when multiple waits occur.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "wait-for-active-shards", - "shortName": null, - "type": "number", - "required": false, - "summary": "The number of shard copies that must be active before proceeding with the operation. Set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value is one, which means it waits for each primary shard to be active.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "wait-for-completion", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, the request blocks until the operation is complete.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "require-alias", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "If `true`, the destination must be an index alias.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "conflicts", - "shortName": null, "type": "string", "required": false, - "summary": "Indicates whether to continue reindexing even when there are conflicts.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "dest", - "shortName": null, - "type": "object", - "required": true, - "summary": "The destination you are copying to.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "max-docs", - "shortName": null, - "type": "number", - "required": false, - "summary": "The maximum number of documents to reindex. By default, all documents are reindexed. If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation. If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "script", - "shortName": null, - "type": "object", - "required": false, - "summary": "The script to run to update the document source or metadata when reindexing.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Filter indices if the provided query rewrites to `match_none` on every shard." }, { - "role": "Named", - "name": "source", - "shortName": null, - "type": "object", - "required": true, - "summary": "The source you are copying from.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Open a point in time.", + "intent": { + "requiresAuth": true + } }, { "path": [ @@ -5555,205 +2415,56 @@ "es" ], "name": "render-search-template", - "summary": "Render a search template.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": false, - "summary": "The ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required." }, { - "role": "Named", + "role": "flag", "name": "file", - "shortName": null, "type": "string", - "required": false, - "summary": "", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "required": false }, { - "role": "Named", + "role": "flag", "name": "params", - "shortName": null, - "type": "object", - "required": false, - "summary": "Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "source", - "shortName": null, - "type": "string", - "required": false, - "summary": "An inline search template. It supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value." }, { - "role": "Named", - "name": "dry-run", - "shortName": null, - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "scripts-painless-execute", - "summary": "Run a script.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ - { - "role": "Named", - "name": "context", - "shortName": null, + "role": "flag", + "name": "source", "type": "string", "required": false, - "summary": "The context that the script should run in. NOTE: Result ordering in the field contexts is not guaranteed.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "context-setup", - "shortName": null, - "type": "object", - "required": false, - "summary": "Additional parameters for the `context`. NOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "script", - "shortName": null, - "type": "object", - "required": false, - "summary": "The Painless script to run.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "An inline search template. It supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Render a search template.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ @@ -5761,94 +2472,50 @@ "es" ], "name": "scroll", - "summary": "Run a scrolling search.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "rest-total-hits-as-int", - "shortName": null, "type": "boolean", "required": false, - "summary": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object." }, { - "role": "Named", + "role": "flag", "name": "scroll", - "shortName": null, "type": "string", "required": false, - "summary": "The period to retain the search context for scrolling.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to retain the search context for scrolling." }, { - "role": "Named", + "role": "flag", "name": "scroll-id", - "shortName": null, "type": "string", "required": true, - "summary": "The scroll ID of the search.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "The scroll ID of the search." + }, + { + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Run a scrolling search.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ @@ -5856,1102 +2523,497 @@ "es" ], "name": "search", - "summary": "Run a search.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "allow-no-indices", - "shortName": null, "type": "boolean", "required": false, - "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." }, { - "role": "Named", + "role": "flag", "name": "allow-partial-search-results", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true` and there are shard request timeouts or shard failures, the request returns partial results. If `false`, it returns an error with no partial results. To override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true` and there are shard request timeouts or shard failures, the request returns partial results. If `false`, it returns an error with no partial results. To override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`." }, { - "role": "Named", + "role": "flag", "name": "analyzer", - "shortName": null, "type": "string", "required": false, - "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "analyze-wildcard", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "batched-reduce-size", - "shortName": null, "type": "number", "required": false, - "summary": "The number of shard results that should be reduced at once on the coordinating node. If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of shard results that should be reduced at once on the coordinating node. If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request." }, { - "role": "Named", + "role": "flag", "name": "ccs-minimize-roundtrips", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests." }, { - "role": "Named", + "role": "flag", "name": "default-operator", - "shortName": null, "type": "string", "required": false, - "summary": "The default operator for the query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The default operator for the query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "df", - "shortName": null, "type": "string", "required": false, - "summary": "The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "expand-wildcards", - "shortName": null, "type": "string", "required": false, "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values such as `open,hidden`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "ignore-throttled", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, concrete, expanded or aliased indices will be ignored when frozen." }, { - "role": "Named", + "role": "flag", "name": "ignore-unavailable", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." }, { - "role": "Named", + "role": "flag", "name": "include-named-queries-score", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the response includes the score contribution from any named queries. This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response includes the score contribution from any named queries. This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead." }, { - "role": "Named", + "role": "flag", "name": "lenient", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", + "role": "flag", "name": "max-concurrent-shard-requests", - "shortName": null, "type": "number", "required": false, - "summary": "The number of concurrent shard requests per node that the search runs concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of concurrent shard requests per node that the search runs concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests." }, { - "role": "Named", + "role": "flag", "name": "preference", - "shortName": null, "type": "string", "required": false, - "summary": "The nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: * `_only_local` to run the search only on shards on the local node. * `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method. * `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method. * `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method. * `_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`. * `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: * `_only_local` to run the search only on shards on the local node. * `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method. * `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method. * `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method. * `_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`. * `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order." }, { - "role": "Named", + "role": "flag", "name": "pre-filter-shard-size", - "shortName": null, "type": "number", "required": false, - "summary": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: * The request targets more than 128 shards. * The request targets one or more read-only index. * The primary sort of the query targets an indexed field.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: * The request targets more than 128 shards. * The request targets one or more read-only index. * The primary sort of the query targets an indexed field." }, { - "role": "Named", + "role": "flag", "name": "request-cache", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the caching of search results is enabled for requests where `size` is `0`. It defaults to index level settings.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the caching of search results is enabled for requests where `size` is `0`. It defaults to index level settings." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value that is used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "scroll", - "shortName": null, "type": "string", "required": false, - "summary": "The period to retain the search context for scrolling. By default, this value cannot exceed `1d` (24 hours). You can change this limit by using the `search.max_keep_alive` cluster-level setting.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to retain the search context for scrolling. By default, this value cannot exceed `1d` (24 hours). You can change this limit by using the `search.max_keep_alive` cluster-level setting." }, { - "role": "Named", + "role": "flag", "name": "search-type", - "shortName": null, "type": "string", "required": false, - "summary": "Indicates how distributed term frequencies are calculated for relevance scoring.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Indicates how distributed term frequencies are calculated for relevance scoring." }, { - "role": "Named", + "role": "flag", "name": "suggest-field", - "shortName": null, "type": "string", "required": false, - "summary": "The field to use for suggestions.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The field to use for suggestions." }, { - "role": "Named", + "role": "flag", "name": "suggest-mode", - "shortName": null, "type": "string", "required": false, - "summary": "The suggest mode. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The suggest mode. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified." }, { - "role": "Named", + "role": "flag", "name": "suggest-size", - "shortName": null, "type": "number", "required": false, - "summary": "The number of suggestions to return. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of suggestions to return. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified." }, { - "role": "Named", + "role": "flag", "name": "suggest-text", - "shortName": null, "type": "string", "required": false, - "summary": "The source text for which the suggestions should be returned. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The source text for which the suggestions should be returned. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified." }, { - "role": "Named", + "role": "flag", "name": "typed-keys", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response." }, { - "role": "Named", + "role": "flag", "name": "rest-total-hits-as-int", - "shortName": null, "type": "boolean", "required": false, - "summary": "Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response." }, { - "role": "Named", + "role": "flag", "name": "source-excludes", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "source-exclude-vectors", - "shortName": null, "type": "boolean", "required": false, - "summary": "Whether vectors should be excluded from _source", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Whether vectors should be excluded from _source" }, { - "role": "Named", + "role": "flag", "name": "source-includes", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "q", - "shortName": null, "type": "string", "required": false, - "summary": "A query in the Lucene query string syntax. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. IMPORTANT: This parameter overrides the query parameter in the request body. If both parameters are specified, documents matching the query request body parameter are not returned.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A query in the Lucene query string syntax. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. IMPORTANT: This parameter overrides the query parameter in the request body. If both parameters are specified, documents matching the query request body parameter are not returned." }, { - "role": "Named", + "role": "flag", "name": "aggregations", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Defines the aggregations that are run as part of the search request.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Defines the aggregations that are run as part of the search request." }, { - "role": "Named", + "role": "flag", "name": "aggs", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Defines the aggregations that are run as part of the search request.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Defines the aggregations that are run as part of the search request." }, { - "role": "Named", + "role": "flag", "name": "collapse", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Collapses search results the values of the specified field.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Collapses search results the values of the specified field." }, { - "role": "Named", + "role": "flag", "name": "explain", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request returns detailed information about score computation as part of a hit.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request returns detailed information about score computation as part of a hit." }, { - "role": "Named", + "role": "flag", "name": "ext", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Configuration of search extensions defined by Elasticsearch plugins.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Configuration of search extensions defined by Elasticsearch plugins." }, { - "role": "Named", + "role": "flag", "name": "from", - "shortName": null, "type": "number", "required": false, - "summary": "The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter." }, { - "role": "Named", + "role": "flag", "name": "highlight", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results." }, { - "role": "Named", + "role": "flag", "name": "track-total-hits", - "shortName": null, "type": "boolean", "required": false, - "summary": "Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query." }, { - "role": "Named", + "role": "flag", "name": "indices-boost", - "shortName": null, "type": "array", "required": false, - "summary": "Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score." }, { - "role": "Named", + "role": "flag", "name": "docvalue-fields", - "shortName": null, "type": "array", "required": false, - "summary": "An array of wildcard (`*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "An array of wildcard (`*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response." }, { - "role": "Named", + "role": "flag", "name": "knn", - "shortName": null, - "type": "object", + "type": "string", "required": false, "summary": "The approximate kNN search to run.", - "defaultValue": null, "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "rank", - "shortName": null, - "type": "object", - "required": false, - "summary": "The Reciprocal Rank Fusion (RRF) to use.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "separator": "," + }, + { + "role": "flag", "name": "min-score", - "shortName": null, "type": "number", "required": false, - "summary": "The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results and results collected by aggregations.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results and results collected by aggregations." }, { - "role": "Named", + "role": "flag", "name": "post-filter", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results." }, { - "role": "Named", + "role": "flag", "name": "profile", - "shortName": null, "type": "boolean", "required": false, - "summary": "Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution." }, { - "role": "Named", + "role": "flag", "name": "query", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "The search definition using the Query DSL.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The search definition using the Query DSL." }, { - "role": "Named", + "role": "flag", "name": "rescore", - "shortName": null, "type": "string", "required": false, "summary": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", - "defaultValue": null, "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "separator": "," }, { - "role": "Named", + "role": "flag", "name": "retriever", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`." }, { - "role": "Named", + "role": "flag", "name": "script-fields", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Retrieve a script evaluation (based on different fields) for each hit.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Retrieve a script evaluation (based on different fields) for each hit." }, { - "role": "Named", + "role": "flag", "name": "search-after", - "shortName": null, "type": "array", "required": false, - "summary": "Used to retrieve the next page of hits using a set of sort values from the previous page.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Used to retrieve the next page of hits using a set of sort values from the previous page." }, { - "role": "Named", + "role": "flag", "name": "size", - "shortName": null, "type": "number", "required": false, - "summary": "The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property." }, { - "role": "Named", + "role": "flag", "name": "slice", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Split a scrolled search into multiple slices that can be consumed independently.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Split a scrolled search into multiple slices that can be consumed independently." }, { - "role": "Named", + "role": "flag", "name": "sort", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of : pairs.", - "defaultValue": null, "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "separator": "," }, { - "role": "Named", + "role": "flag", "name": "source", - "shortName": null, "type": "boolean", "required": false, - "summary": "The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. If the `stored_fields` property is specified, the `_source` property defaults to `false`. Otherwise, it defaults to `true`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. If the `stored_fields` property is specified, the `_source` property defaults to `false`. Otherwise, it defaults to `true`." }, { - "role": "Named", + "role": "flag", "name": "fields", - "shortName": null, "type": "array", "required": false, - "summary": "An array of wildcard (`*`) field patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "An array of wildcard (`*`) field patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response." }, { - "role": "Named", + "role": "flag", "name": "suggest", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Defines a suggester that provides similar looking terms based on a provided text.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Defines a suggester that provides similar looking terms based on a provided text." }, { - "role": "Named", + "role": "flag", "name": "terminate-after", - "shortName": null, "type": "number", "required": false, - "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early." }, { - "role": "Named", + "role": "flag", "name": "timeout", - "shortName": null, "type": "string", "required": false, - "summary": "The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout." }, { - "role": "Named", + "role": "flag", "name": "track-scores", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, calculate and return document scores, even if the scores are not used for sorting.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, calculate and return document scores, even if the scores are not used for sorting." }, { - "role": "Named", + "role": "flag", "name": "version", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request returns the document version as part of a hit.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request returns the document version as part of a hit." }, { - "role": "Named", + "role": "flag", "name": "seq-no-primary-term", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the request returns sequence number and primary term of the last modification of each hit." }, { - "role": "Named", + "role": "flag", "name": "stored-fields", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` property defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response.", - "defaultValue": null, "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "separator": "," }, { - "role": "Named", + "role": "flag", "name": "pit", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Limit the search to a point in time (PIT). If you provide a PIT, you cannot specify an `` in the request path.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Limit the search to a point in time (PIT). If you provide a PIT, you cannot specify an `` in the request path." }, { - "role": "Named", + "role": "flag", "name": "runtime-mappings", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "One or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "One or more runtime fields in the search request. These fields take precedence over mapped fields with the same name." }, { - "role": "Named", + "role": "flag", "name": "stats", - "shortName": null, "type": "array", "required": false, - "summary": "The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Run a search.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ @@ -6959,350 +3021,253 @@ "es" ], "name": "search-mvt", - "summary": "Search a vector tile.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": true, "summary": "A list of indices, data streams, or aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. To search a remote cluster, use the `:` syntax.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "field", - "shortName": null, "type": "string", "required": true, - "summary": "A field that contains the geospatial data to return. It must be a `geo_point` or `geo_shape` field. The field must have doc values enabled. It cannot be a nested field. NOTE: Vector tiles do not natively support geometry collections. For `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection. This behavior may change in a future release.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "A field that contains the geospatial data to return. It must be a `geo_point` or `geo_shape` field. The field must have doc values enabled. It cannot be a nested field. NOTE: Vector tiles do not natively support geometry collections. For `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection. This behavior may change in a future release." + }, + { + "role": "flag", "name": "zoom", - "shortName": null, "type": "number", "required": true, - "summary": "The zoom level of the vector tile to search. It accepts `0` to `29`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "The zoom level of the vector tile to search. It accepts `0` to `29`." + }, + { + "role": "flag", "name": "x", - "shortName": null, "type": "number", "required": true, - "summary": "The X coordinate for the vector tile to search.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "The X coordinate for the vector tile to search." + }, + { + "role": "flag", "name": "y", - "shortName": null, "type": "number", "required": true, - "summary": "The Y coordinate for the vector tile to search.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "summary": "The Y coordinate for the vector tile to search." + }, + { + "role": "flag", "name": "aggs", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Sub-aggregations for the geotile_grid. It supports the following aggregation types: - `avg` - `boxplot` - `cardinality` - `extended stats` - `max` - `median absolute deviation` - `min` - `percentile` - `percentile-rank` - `stats` - `sum` - `value count` The aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Sub-aggregations for the geotile_grid. It supports the following aggregation types: - `avg` - `boxplot` - `cardinality` - `extended stats` - `max` - `median absolute deviation` - `min` - `percentile` - `percentile-rank` - `stats` - `sum` - `value count` The aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations." }, { - "role": "Named", + "role": "flag", "name": "buffer", - "shortName": null, "type": "number", "required": false, - "summary": "The size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile." }, { - "role": "Named", + "role": "flag", "name": "exact-bounds", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `false`, the meta layer's feature is the bounding box of the tile. If `true`, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. The aggregation runs on values that intersect the `//` tile with `wrap_longitude` set to `false`. The resulting bounding box may be larger than the vector tile.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the meta layer's feature is the bounding box of the tile. If `true`, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. The aggregation runs on values that intersect the `//` tile with `wrap_longitude` set to `false`. The resulting bounding box may be larger than the vector tile." }, { - "role": "Named", + "role": "flag", "name": "extent", - "shortName": null, "type": "number", "required": false, - "summary": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides." }, { - "role": "Named", + "role": "flag", "name": "fields", - "shortName": null, "type": "string", "required": false, "summary": "The fields to return in the `hits` layer. It supports wildcards (`*`). This parameter does not support fields with array values. Fields with array values may return inconsistent results.", - "defaultValue": null, "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "separator": "," }, { - "role": "Named", + "role": "flag", "name": "grid-agg", - "shortName": null, "type": "string", "required": false, - "summary": "The aggregation used to create a grid for the `field`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The aggregation used to create a grid for the `field`." }, { - "role": "Named", + "role": "flag", "name": "grid-precision", - "shortName": null, "type": "number", "required": false, - "summary": "Additional zoom levels available through the aggs layer. For example, if `` is `7` and `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results don't include the aggs layer.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Additional zoom levels available through the aggs layer. For example, if `` is `7` and `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results don't include the aggs layer." }, { - "role": "Named", + "role": "flag", "name": "grid-type", - "shortName": null, "type": "string", "required": false, - "summary": "Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a `geotile_grid` cell. If `grid, each feature is a polygon of the cells bounding box. If `point`, each feature is a Point that is the centroid of the cell.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a `geotile_grid` cell. If `grid, each feature is a polygon of the cells bounding box. If `point`, each feature is a Point that is the centroid of the cell." }, { - "role": "Named", + "role": "flag", "name": "query", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "The query DSL used to filter documents for the search.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The query DSL used to filter documents for the search." }, { - "role": "Named", + "role": "flag", "name": "runtime-mappings", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name." }, { - "role": "Named", + "role": "flag", "name": "size", - "shortName": null, "type": "number", "required": false, - "summary": "The maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don't include the hits layer.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don't include the hits layer." }, { - "role": "Named", + "role": "flag", "name": "sort", - "shortName": null, "type": "string", "required": false, "summary": "Sort the features in the hits layer. By default, the API calculates a bounding box for each feature. It sorts features based on this box's diagonal length, from longest to shortest.", - "defaultValue": null, "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "separator": "," }, { - "role": "Named", + "role": "flag", "name": "track-total-hits", - "shortName": null, "type": "boolean", "required": false, - "summary": "The number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query." }, { - "role": "Named", + "role": "flag", "name": "with-labels", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * `Point` and `MultiPoint` features will have one of the points selected. * `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * `LineString` features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag `_mvt_label_position`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * `Point` and `MultiPoint` features will have one of the points selected. * `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * `LineString` features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag `_mvt_label_position`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Search a vector tile.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "search-shards", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "allow-no-indices", + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." + }, + { + "role": "flag", + "name": "expand-wildcards", + "type": "string", + "required": false, + "summary": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "repeatable": true + }, + { + "role": "flag", + "name": "ignore-unavailable", + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request retrieves information from the local node only." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. IT can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "preference", + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default." + }, + { + "role": "flag", + "name": "routing", + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Get the search shards.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ @@ -7310,34465 +3275,34072 @@ "es" ], "name": "search-template", - "summary": "Run a search with a search template.", - "notes": null, - "usage": null, - "examples": [], "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", "required": false, "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`).", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "allow-no-indices", - "shortName": null, "type": "boolean", "required": false, - "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." }, { - "role": "Named", + "role": "flag", "name": "ccs-minimize-roundtrips", - "shortName": null, "type": "boolean", "required": false, - "summary": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." }, { - "role": "Named", + "role": "flag", "name": "expand-wildcards", - "shortName": null, "type": "string", "required": false, "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "ignore-throttled", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled." }, { - "role": "Named", + "role": "flag", "name": "ignore-unavailable", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." }, { - "role": "Named", + "role": "flag", "name": "preference", - "shortName": null, "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. It is random by default.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The node or shard the operation should be performed on. It is random by default." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "scroll", - "shortName": null, "type": "string", "required": false, - "summary": "Specifies how long a consistent view of the index should be maintained for scrolled search.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Specifies how long a consistent view of the index should be maintained for scrolled search." }, { - "role": "Named", + "role": "flag", "name": "search-type", - "shortName": null, "type": "string", "required": false, - "summary": "The type of the search operation.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The type of the search operation." }, { - "role": "Named", + "role": "flag", "name": "rest-total-hits-as-int", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, `hits.total` is rendered as an integer in the response. If `false`, it is rendered as an object.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, `hits.total` is rendered as an integer in the response. If `false`, it is rendered as an object." }, { - "role": "Named", + "role": "flag", "name": "typed-keys", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the response prefixes aggregation and suggester names with their respective types.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response prefixes aggregation and suggester names with their respective types." }, { - "role": "Named", + "role": "flag", "name": "explain", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, returns detailed information about score calculation as part of each hit. If you specify both this and the `explain` query parameter, the API uses only the query parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, returns detailed information about score calculation as part of each hit. If you specify both this and the `explain` query parameter, the API uses only the query parameter." }, { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": false, - "summary": "The ID of the search template to use. If no `source` is specified, this parameter is required.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The ID of the search template to use. If no `source` is specified, this parameter is required." }, { - "role": "Named", + "role": "flag", "name": "params", - "shortName": null, - "type": "object", + "type": "string", "required": false, - "summary": "Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value." }, { - "role": "Named", + "role": "flag", "name": "profile", - "shortName": null, "type": "boolean", "required": false, - "summary": "If `true`, the query execution is profiled.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the query execution is profiled." }, { - "role": "Named", + "role": "flag", "name": "source", - "shortName": null, "type": "string", "required": false, - "summary": "An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no `id` is specified, this parameter is required.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no `id` is specified, this parameter is required." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Run a search with a search template.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "terms-enum", - "summary": "Get terms in an index.", - "notes": null, - "usage": null, - "examples": [], + "name": "count", "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", - "required": true, - "summary": "A comma-separated list of data streams, indices, and index aliases to search. Wildcard (`*`) expressions are supported. To search all data streams or indices, omit this parameter or use `*` or `_all`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`.", + "repeatable": true }, { - "role": "Named", - "name": "field", - "shortName": null, - "type": "string", - "required": true, - "summary": "The string to match at the start of indexed terms. If not provided, all terms in the field are considered.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "size", - "shortName": null, - "type": "number", + "role": "flag", + "name": "allow-no-indices", + "type": "boolean", "required": false, - "summary": "The number of matching terms to return.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." }, { - "role": "Named", - "name": "timeout", - "shortName": null, + "role": "flag", + "name": "analyzer", "type": "string", "required": false, - "summary": "The maximum length of time to spend collecting results. If the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", - "name": "case-insensitive", - "shortName": null, + "role": "flag", + "name": "analyze-wildcard", "type": "boolean", "required": false, - "summary": "When `true`, the provided search string is matched against index terms without case sensitivity.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", - "name": "index-filter", - "shortName": null, - "type": "object", + "role": "flag", + "name": "default-operator", + "type": "string", "required": false, - "summary": "Filter an index shard if the provided query rewrites to `match_none`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", - "name": "string", - "shortName": null, + "role": "flag", + "name": "df", "type": "string", "required": false, - "summary": "The string to match at the start of indexed terms. If it is not provided, all terms in the field are considered. > info > The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", - "name": "search-after", - "shortName": null, + "role": "flag", + "name": "expand-wildcards", "type": "string", "required": false, - "summary": "The string after which terms in the index should be returned. It allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "repeatable": true }, { - "role": "Named", - "name": "input-file", - "shortName": null, - "type": "string", + "role": "flag", + "name": "ignore-throttled", + "type": "boolean", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, concrete, expanded, or aliased indices are ignored when frozen." }, { - "role": "Named", - "name": "dry-run", - "shortName": null, + "role": "flag", + "name": "ignore-unavailable", "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - } - ], - "aliases": null, - "hidden": false - }, - { - "path": [ - "stack", - "es" - ], - "name": "termvectors", - "summary": "Get term vector information.", - "notes": null, - "usage": null, - "examples": [], - "parameters": [ + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." + }, { - "role": "Named", - "name": "index", - "shortName": null, - "type": "string", - "required": true, - "summary": "The name of the index that contains the document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "id", - "shortName": null, - "type": "string", + "role": "flag", + "name": "lenient", + "type": "boolean", + "required": false, + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified." + }, + { + "role": "flag", + "name": "min-score", + "type": "number", "required": false, - "summary": "A unique identifier for the document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The minimum `_score` value that documents must have to be included in the result." }, { - "role": "Named", + "role": "flag", "name": "preference", - "shortName": null, "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. It is random by default.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The node or shard the operation should be performed on. By default, it is random." }, { - "role": "Named", - "name": "realtime", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "routing", + "type": "string", "required": false, - "summary": "If true, the request is real-time as opposed to near-real-time.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A custom value used to route operations to a specific shard.", + "repeatable": true }, { - "role": "Named", - "name": "doc", - "shortName": null, - "type": "object", + "role": "flag", + "name": "terminate-after", + "type": "number", "required": false, - "summary": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers." }, { - "role": "Named", - "name": "filter", - "shortName": null, - "type": "object", + "role": "flag", + "name": "q", + "type": "string", "required": false, - "summary": "Filter terms based on their tf-idf scores. This could be useful in order find out a good characteristic vector of a document. This feature works in a similar manner to the second phase of the More Like This Query.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The query in Lucene query string syntax. This parameter cannot be used with a request body." }, { - "role": "Named", - "name": "per-field-analyzer", - "shortName": null, - "type": "object", + "role": "flag", + "name": "query", + "type": "string", "required": false, - "summary": "Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Defines the search query using Query DSL. A request body query cannot be used with the `q` query string parameter." }, { - "role": "Named", - "name": "fields", - "shortName": null, - "type": "array", + "role": "flag", + "name": "input-file", + "type": "string", "required": false, - "summary": "A list of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "field-statistics", - "shortName": null, + "role": "dryRun", + "name": "dry-run", "type": "boolean", "required": false, - "summary": "If `true`, the response includes: * The document count (how many documents contain this field). * The sum of document frequencies (the sum of document frequencies for all terms in this field). * The sum of total term frequencies (the sum of total term frequencies of each term in this field).", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Count search results.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "explain", + "parameters": [ { - "role": "Named", - "name": "offsets", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "id", + "type": "string", + "required": true, + "summary": "The document identifier." + }, + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "Index names that are used to limit the request. Only a single index name can be provided to this parameter." + }, + { + "role": "flag", + "name": "analyzer", + "type": "string", "required": false, - "summary": "If `true`, the response includes term offsets.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", - "name": "payloads", - "shortName": null, + "role": "flag", + "name": "analyze-wildcard", "type": "boolean", "required": false, - "summary": "If `true`, the response includes term payloads.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", - "name": "positions", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "default-operator", + "type": "string", "required": false, - "summary": "If `true`, the response includes term positions.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified." }, { - "role": "Named", - "name": "term-statistics", - "shortName": null, + "role": "flag", + "name": "df", + "type": "string", + "required": false, + "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified." + }, + { + "role": "flag", + "name": "lenient", "type": "boolean", "required": false, - "summary": "If `true`, the response includes: * The total term frequency (how often a term occurs in all documents). * The document frequency (the number of documents containing the current term). By default these values are not returned since term statistics can have a serious performance impact.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified." + }, + { + "role": "flag", + "name": "preference", + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, - "summary": "A custom value that is used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": ",", - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A custom value used to route operations to a specific shard.", + "repeatable": true }, { - "role": "Named", - "name": "version", - "shortName": null, - "type": "number", + "role": "flag", + "name": "source", + "type": "boolean", "required": false, - "summary": "If `true`, returns the document version as part of a hit.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "`True` or `false` to return the `_source` field or not or a list of fields to return.", + "repeatable": true }, { - "role": "Named", - "name": "version-type", - "shortName": null, + "role": "flag", + "name": "source-excludes", + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "repeatable": true + }, + { + "role": "flag", + "name": "source-includes", + "type": "string", + "required": false, + "summary": "A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.", + "repeatable": true + }, + { + "role": "flag", + "name": "stored-fields", + "type": "string", + "required": false, + "summary": "A comma-separated list of stored fields to return in the response.", + "repeatable": true + }, + { + "role": "flag", + "name": "q", + "type": "string", + "required": false, + "summary": "The query in the Lucene query string syntax." + }, + { + "role": "flag", + "name": "query", "type": "string", "required": false, - "summary": "The version type.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Defines the search definition using the Query DSL." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Explain a document match result.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "update", - "summary": "Update a document.", - "notes": null, - "usage": null, - "examples": [], + "name": "field-caps", "parameters": [ { - "role": "Named", - "name": "id", - "shortName": null, - "type": "string", - "required": true, - "summary": "A unique identifier for the document to be updated.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", - "required": true, - "summary": "The name of the target index. By default, the index is created automatically if it doesn't exist.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, - { - "role": "Named", - "name": "if-primary-term", - "shortName": null, - "type": "number", "required": false, - "summary": "Only perform the operation if the document has this primary term.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", + "repeatable": true }, { - "role": "Named", - "name": "if-seq-no", - "shortName": null, - "type": "number", + "role": "flag", + "name": "allow-no-indices", + "type": "boolean", "required": false, - "summary": "Only perform the operation if the document has this sequence number.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." }, { - "role": "Named", - "name": "include-source-on-error", - "shortName": null, + "role": "flag", + "name": "expand-wildcards", + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "repeatable": true + }, + { + "role": "flag", + "name": "ignore-unavailable", "type": "boolean", "required": false, - "summary": "True or false if to include the document source in the error message in case of parsing errors.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." }, { - "role": "Named", - "name": "lang", - "shortName": null, + "role": "flag", + "name": "include-unmapped", + "type": "boolean", + "required": false, + "summary": "If true, unmapped fields are included in the response." + }, + { + "role": "flag", + "name": "filters", "type": "string", "required": false, - "summary": "The script language.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list of filters to apply to the response.", + "repeatable": true }, { - "role": "Named", - "name": "refresh", - "shortName": null, - "type": "boolean", + "role": "flag", + "name": "types", + "type": "array", "required": false, - "summary": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list of field types to include. Any fields that do not match one of these types will be excluded from the results. It defaults to empty, meaning that all field types are returned." }, { - "role": "Named", - "name": "require-alias", - "shortName": null, + "role": "flag", + "name": "include-empty-fields", "type": "boolean", "required": false, - "summary": "If `true`, the destination must be an index alias.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If false, empty fields are not included in the response." }, { - "role": "Named", - "name": "retry-on-conflict", - "shortName": null, - "type": "number", + "role": "flag", + "name": "fields", + "type": "string", "required": false, - "summary": "The number of times the operation should be retried when a conflict occurs.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", + "repeatable": true, + "separator": "," }, { - "role": "Named", - "name": "routing", - "shortName": null, + "role": "flag", + "name": "index-filter", "type": "string", "required": false, - "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Filter indices if the provided query rewrites to `match_none` on every shard. IMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request. For instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range. However, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document." }, { - "role": "Named", - "name": "timeout", - "shortName": null, + "role": "flag", + "name": "runtime-mappings", "type": "string", "required": false, - "summary": "The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings." }, { - "role": "Named", - "name": "wait-for-active-shards", - "shortName": null, - "type": "number", + "role": "flag", + "name": "input-file", + "type": "string", "required": false, - "summary": "The number of copies of each shard that must be active before proceeding with the operation. Set to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1). The default value of `1` means it waits for each primary shard to be active.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "source-excludes", - "shortName": null, + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get the field capabilities.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "mtermvectors", + "parameters": [ + { + "role": "flag", + "name": "index", "type": "string", "required": false, - "summary": "The source fields you want to exclude.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The name of the index that contains the documents." }, { - "role": "Named", - "name": "source-includes", - "shortName": null, + "role": "flag", + "name": "fields", "type": "string", "required": false, - "summary": "The source fields you want to retrieve.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A comma-separated list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "repeatable": true }, { - "role": "Named", - "name": "detect-noop", - "shortName": null, + "role": "flag", + "name": "field-statistics", "type": "boolean", "required": false, - "summary": "If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies." }, { - "role": "Named", - "name": "doc", - "shortName": null, - "type": "object", + "role": "flag", + "name": "offsets", + "type": "boolean", "required": false, - "summary": "A partial update to an existing document. If both `doc` and `script` are specified, `doc` is ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response includes term offsets." }, { - "role": "Named", - "name": "doc-as-upsert", - "shortName": null, + "role": "flag", + "name": "payloads", "type": "boolean", "required": false, - "summary": "If `true`, use the contents of 'doc' as the value of 'upsert'. NOTE: Using ingest pipelines with `doc_as_upsert` is not supported.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response includes term payloads." }, { - "role": "Named", - "name": "script", - "shortName": null, - "type": "object", + "role": "flag", + "name": "positions", + "type": "boolean", "required": false, - "summary": "The script to run to update the document.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response includes term positions." }, { - "role": "Named", - "name": "scripted-upsert", - "shortName": null, + "role": "flag", + "name": "preference", + "type": "string", + "required": false, + "summary": "The node or shard the operation should be performed on. It is random by default." + }, + { + "role": "flag", + "name": "realtime", "type": "boolean", "required": false, - "summary": "If `true`, run the script whether or not the document exists.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If true, the request is real-time as opposed to near-real-time." }, { - "role": "Named", - "name": "source", - "shortName": null, + "role": "flag", + "name": "routing", + "type": "string", + "required": false, + "summary": "A custom value used to route operations to a specific shard.", + "repeatable": true + }, + { + "role": "flag", + "name": "term-statistics", "type": "boolean", "required": false, - "summary": "If `false`, turn off source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If true, the response includes term frequency and document frequency." }, { - "role": "Named", - "name": "upsert", - "shortName": null, - "type": "object", + "role": "flag", + "name": "version", + "type": "number", + "required": false, + "summary": "If `true`, returns the document version as part of a hit." + }, + { + "role": "flag", + "name": "version-type", + "type": "string", + "required": false, + "summary": "The version type." + }, + { + "role": "flag", + "name": "docs", + "type": "array", + "required": false, + "summary": "An array of existing or artificial documents." + }, + { + "role": "flag", + "name": "ids", + "type": "array", "required": false, - "summary": "If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is run.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A simplified syntax to specify documents by their ID if they're in the same index." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false + "summary": "Get multiple term vectors.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } }, { "path": [ "stack", "es" ], - "name": "update-by-query", - "summary": "Update documents.", - "notes": null, - "usage": null, - "examples": [], + "name": "rank-eval", "parameters": [ { - "role": "Named", + "role": "flag", "name": "index", - "shortName": null, "type": "string", - "required": true, - "summary": "A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "required": false, + "summary": "A comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", + "repeatable": true }, { - "role": "Named", + "role": "flag", "name": "allow-no-indices", - "shortName": null, "type": "boolean", "required": false, - "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." }, { - "role": "Named", - "name": "analyzer", - "shortName": null, + "role": "flag", + "name": "expand-wildcards", "type": "string", "required": false, - "summary": "The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "repeatable": true }, { - "role": "Named", - "name": "analyze-wildcard", - "shortName": null, + "role": "flag", + "name": "ignore-unavailable", "type": "boolean", "required": false, - "summary": "If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." }, { - "role": "Named", - "name": "default-operator", - "shortName": null, + "role": "flag", + "name": "search-type", "type": "string", "required": false, - "summary": "The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Search operation type" }, { - "role": "Named", - "name": "df", - "shortName": null, + "role": "flag", + "name": "requests", + "type": "array", + "required": true, + "summary": "A set of typical search requests, together with their provided ratings." + }, + { + "role": "flag", + "name": "metric", "type": "string", "required": false, - "summary": "The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "Definition of the evaluation metric to calculate." }, { - "role": "Named", - "name": "expand-wildcards", - "shortName": null, + "role": "flag", + "name": "input-file", "type": "string", "required": false, - "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", - "defaultValue": null, - "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "from", - "shortName": null, + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Evaluate ranked search results.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "terms-enum", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "A comma-separated list of data streams, indices, and index aliases to search. Wildcard (`*`) expressions are supported. To search all data streams or indices, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "field", + "type": "string", + "required": true, + "summary": "The string to match at the start of indexed terms. If not provided, all terms in the field are considered." + }, + { + "role": "flag", + "name": "size", "type": "number", "required": false, - "summary": "Skips the specified number of documents.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The number of matching terms to return." }, { - "role": "Named", - "name": "ignore-unavailable", - "shortName": null, + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "The maximum length of time to spend collecting results. If the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty." + }, + { + "role": "flag", + "name": "case-insensitive", "type": "boolean", "required": false, - "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "When `true`, the provided search string is matched against index terms without case sensitivity." }, { - "role": "Named", - "name": "lenient", - "shortName": null, + "role": "flag", + "name": "index-filter", + "type": "string", + "required": false, + "summary": "Filter an index shard if the provided query rewrites to `match_none`." + }, + { + "role": "flag", + "name": "string", + "type": "string", + "required": false, + "summary": "The string to match at the start of indexed terms. If it is not provided, all terms in the field are considered. > info > The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766." + }, + { + "role": "flag", + "name": "search-after", + "type": "string", + "required": false, + "summary": "The string after which terms in the index should be returned. It allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", "type": "boolean", "required": false, - "summary": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get terms in an index.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "termvectors", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "The name of the index that contains the document." }, { - "role": "Named", - "name": "pipeline", - "shortName": null, + "role": "flag", + "name": "id", "type": "string", "required": false, - "summary": "The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A unique identifier for the document." }, { - "role": "Named", + "role": "flag", "name": "preference", - "shortName": null, "type": "string", "required": false, - "summary": "The node or shard the operation should be performed on. It is random by default.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The node or shard the operation should be performed on. It is random by default." }, { - "role": "Named", - "name": "q", - "shortName": null, + "role": "flag", + "name": "realtime", + "type": "boolean", + "required": false, + "summary": "If true, the request is real-time as opposed to near-real-time." + }, + { + "role": "flag", + "name": "doc", "type": "string", "required": false, - "summary": "A query in the Lucene query string syntax.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "An artificial document (a document not present in the index) for which you want to retrieve term vectors." }, { - "role": "Named", - "name": "refresh", - "shortName": null, + "role": "flag", + "name": "filter", + "type": "string", + "required": false, + "summary": "Filter terms based on their tf-idf scores. This could be useful in order find out a good characteristic vector of a document. This feature works in a similar manner to the second phase of the More Like This Query." + }, + { + "role": "flag", + "name": "per-field-analyzer", + "type": "string", + "required": false, + "summary": "Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated." + }, + { + "role": "flag", + "name": "fields", + "type": "array", + "required": false, + "summary": "A list of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters." + }, + { + "role": "flag", + "name": "field-statistics", "type": "boolean", "required": false, - "summary": "If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes. This is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response includes: * The document count (how many documents contain this field). * The sum of document frequencies (the sum of document frequencies for all terms in this field). * The sum of total term frequencies (the sum of total term frequencies of each term in this field)." }, { - "role": "Named", - "name": "request-cache", - "shortName": null, + "role": "flag", + "name": "offsets", "type": "boolean", "required": false, - "summary": "If `true`, the request cache is used for this request. It defaults to the index-level setting.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response includes term offsets." }, { - "role": "Named", - "name": "requests-per-second", - "shortName": null, - "type": "number", + "role": "flag", + "name": "payloads", + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes term payloads." + }, + { + "role": "flag", + "name": "positions", + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes term positions." + }, + { + "role": "flag", + "name": "term-statistics", + "type": "boolean", "required": false, - "summary": "The throttle for this request in sub-requests per second.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, the response includes: * The total term frequency (how often a term occurs in all documents). * The document frequency (the number of documents containing the current term). By default these values are not returned since term statistics can have a serious performance impact." }, { - "role": "Named", + "role": "flag", "name": "routing", - "shortName": null, "type": "string", "required": false, - "summary": "A custom value used to route operations to a specific shard.", - "defaultValue": null, + "summary": "A custom value that is used to route operations to a specific shard.", "repeatable": true, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "separator": "," }, { - "role": "Named", - "name": "scroll", - "shortName": null, - "type": "string", + "role": "flag", + "name": "version", + "type": "number", "required": false, - "summary": "The period to retain the search context for scrolling.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "If `true`, returns the document version as part of a hit." }, { - "role": "Named", - "name": "scroll-size", - "shortName": null, - "type": "number", + "role": "flag", + "name": "version-type", + "type": "string", "required": false, - "summary": "The size of the scroll request that powers the operation.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The version type." }, { - "role": "Named", - "name": "search-timeout", - "shortName": null, + "role": "flag", + "name": "input-file", "type": "string", "required": false, - "summary": "An explicit timeout for each search request. By default, there is no timeout.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "search-type", - "shortName": null, + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get term vector information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "delete-script", + "parameters": [ + { + "role": "flag", + "name": "id", + "type": "string", + "required": true, + "summary": "The identifier for the stored script or search template." + }, + { + "role": "flag", + "name": "master-timeout", "type": "string", "required": false, - "summary": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The 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. It can also be set to `-1` to indicate that the request should never timeout." }, { - "role": "Named", - "name": "slices", - "shortName": null, - "type": "number", + "role": "flag", + "name": "timeout", + "type": "string", "required": false, - "summary": "The number of slices this task should be divided into.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." }, { - "role": "Named", - "name": "sort", - "shortName": null, - "type": "array", + "role": "flag", + "name": "input-file", + "type": "string", "required": false, - "summary": "A comma-separated list of : pairs.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "stats", - "shortName": null, - "type": "array", + "role": "dryRun", + "name": "dry-run", + "type": "boolean", "required": false, - "summary": "The specific `tag` of the request for logging and statistical purposes.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Delete a script or search template.", + "intent": { + "destructive": true, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "get-script", + "parameters": [ + { + "role": "flag", + "name": "id", + "type": "string", + "required": true, + "summary": "The identifier for the stored script or search template." }, { - "role": "Named", - "name": "terminate-after", - "shortName": null, - "type": "number", + "role": "flag", + "name": "master-timeout", + "type": "string", "required": false, - "summary": "The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." }, { - "role": "Named", - "name": "timeout", - "shortName": null, + "role": "flag", + "name": "input-file", "type": "string", "required": false, - "summary": "The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. By default, it is one minute. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "version", - "shortName": null, + "role": "dryRun", + "name": "dry-run", "type": "boolean", "required": false, - "summary": "If `true`, returns the document version as part of a hit.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get a script or search template.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "get-script-context", + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "version-type", - "shortName": null, + "role": "dryRun", + "name": "dry-run", "type": "boolean", "required": false, - "summary": "Should the document increment the version number (internal) on hit or not (reindex)", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null - }, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get script contexts.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "get-script-languages", + "parameters": [ { - "role": "Named", - "name": "wait-for-active-shards", - "shortName": null, - "type": "number", + "role": "flag", + "name": "input-file", + "type": "string", "required": false, - "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` parameter controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the bulk API.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "wait-for-completion", - "shortName": null, + "role": "dryRun", + "name": "dry-run", "type": "boolean", "required": false, - "summary": "If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/{taskId}`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get script languages.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "put-script", + "parameters": [ + { + "role": "flag", + "name": "id", + "type": "string", + "required": true, + "summary": "The identifier for the stored script or search template. It must be unique within the cluster." + }, + { + "role": "flag", + "name": "context", + "type": "string", + "required": false, + "summary": "The context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context." }, { - "role": "Named", - "name": "max-docs", - "shortName": null, - "type": "number", + "role": "flag", + "name": "master-timeout", + "type": "string", "required": false, - "summary": "The maximum number of documents to update.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The 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. It can also be set to `-1` to indicate that the request should never timeout." }, { - "role": "Named", - "name": "query", - "shortName": null, - "type": "object", + "role": "flag", + "name": "timeout", + "type": "string", "required": false, - "summary": "The documents to update using the Query DSL.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." }, { - "role": "Named", + "role": "flag", "name": "script", - "shortName": null, - "type": "object", + "type": "string", + "required": true, + "summary": "The script or search template, its parameters, and its language." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", "required": false, - "summary": "The script to run to update the document source or metadata when updating.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", - "name": "slice", - "shortName": null, - "type": "object", + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Create or update a script or search template.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "scripts-painless-execute", + "parameters": [ + { + "role": "flag", + "name": "context", + "type": "string", "required": false, - "summary": "Slice the request manually using the provided slice ID and total number of slices.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The context that the script should run in. NOTE: Result ordering in the field contexts is not guaranteed." }, { - "role": "Named", - "name": "conflicts", - "shortName": null, + "role": "flag", + "name": "context-setup", + "type": "string", + "required": false, + "summary": "Additional parameters for the `context`. NOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`." + }, + { + "role": "flag", + "name": "script", "type": "string", "required": false, - "summary": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "The Painless script to run." }, { - "role": "Named", + "role": "flag", "name": "input-file", - "shortName": null, "type": "string", "required": false, - "summary": "path to a JSON file to use as command input", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "path to a JSON file to use as command input" }, { - "role": "Named", + "role": "dryRun", "name": "dry-run", - "shortName": null, "type": "boolean", "required": false, - "summary": "validate all inputs and exit without performing any action", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "validate all inputs and exit without performing any action" } ], - "aliases": null, - "hidden": false - } - ], - "namespaces": [ + "summary": "Run a script.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, { - "segment": "async-search", - "summary": "Elasticsearch async-search API commands", - "notes": null, - "options": [], - "defaultCommand": null, - "commands": [ + "path": [ + "stack", + "es" + ], + "name": "health-report", + "parameters": [ { - "path": [ - "stack", - "es", - "async-search" + "role": "flag", + "name": "feature", + "type": "string", + "required": false, + "summary": "A feature of the cluster, as returned by the top-level health report API.", + "repeatable": true + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "Explicit operation timeout." + }, + { + "role": "flag", + "name": "verbose", + "type": "boolean", + "required": false, + "summary": "Opt-in for more information about the health of the system." + }, + { + "role": "flag", + "name": "size", + "type": "number", + "required": false, + "summary": "Limit the number of affected resources the health report API returns." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get the cluster health.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "info", + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get cluster info.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "ping", + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Ping the cluster.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "delete-by-query-rethrottle", + "parameters": [ + { + "role": "flag", + "name": "task-id", + "type": "string", + "required": true, + "summary": "The ID for the task." + }, + { + "role": "flag", + "name": "requests-per-second", + "type": "number", + "required": true, + "summary": "The throttle for this request in sub-requests per second. To disable throttling, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Throttle a delete by query operation.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "reindex-rethrottle", + "parameters": [ + { + "role": "flag", + "name": "task-id", + "type": "string", + "required": true, + "summary": "The task identifier, which can be found by using the tasks API." + }, + { + "role": "flag", + "name": "requests-per-second", + "type": "number", + "required": true, + "summary": "The throttle for this request in sub-requests per second. It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Throttle a reindex operation.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es" + ], + "name": "update-by-query-rethrottle", + "parameters": [ + { + "role": "flag", + "name": "task-id", + "type": "string", + "required": true, + "summary": "The ID for the task." + }, + { + "role": "flag", + "name": "requests-per-second", + "type": "number", + "required": true, + "summary": "The throttle for this request in sub-requests per second. To turn off throttling, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Throttle an update by query operation.", + "intent": { + "requiresAuth": true + } + } + ], + "namespaces": [ + { + "segment": "async-search", + "commands": [ + { + "path": [ + "stack", + "es", + "async-search" ], "name": "delete", + "parameters": [ + { + "role": "flag", + "name": "id", + "type": "string", + "required": true, + "summary": "A unique identifier for the async search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Delete an async search.", - "notes": null, - "usage": null, - "examples": [], + "intent": { + "destructive": true, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "async-search" + ], + "name": "get", + "parameters": [ + { + "role": "flag", + "name": "id", + "type": "string", + "required": true, + "summary": "A unique identifier for the async search." + }, + { + "role": "flag", + "name": "keep-alive", + "type": "string", + "required": false, + "summary": "The length of time that the async search should be available in the cluster. When not specified, the `keep_alive` set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted." + }, + { + "role": "flag", + "name": "typed-keys", + "type": "boolean", + "required": false, + "summary": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" + }, + { + "role": "flag", + "name": "wait-for-completion-timeout", + "type": "string", + "required": false, + "summary": "Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait." + }, + { + "role": "flag", + "name": "return-intermediate-results", + "type": "boolean", + "required": false, + "summary": "Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout expires or if no wait_for_completion_timeout is specified. If true and the search is still running, the search response will include any hits and partial aggregations that are available. If false and the search is still running, the search response will not include any hits (but possibly include total hits) nor will include any partial aggregations. When not specified, the intermediate results are returned for running queries." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get async search results.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "async-search" + ], + "name": "status", "parameters": [ { - "role": "Named", + "role": "flag", "name": "id", - "shortName": null, "type": "string", "required": true, - "summary": "A unique identifier for the async search.", - "defaultValue": null, - "repeatable": false, - "separator": null, - "aliases": null, - "enumValues": null, - "elementType": null, - "hidden": false, - "validations": null + "summary": "A unique identifier for the async search." + }, + { + "role": "flag", + "name": "keep-alive", + "type": "string", + "required": false, + "summary": "The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get the async search status.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "async-search" + ], + "name": "submit", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "repeatable": true + }, + { + "role": "flag", + "name": "wait-for-completion-timeout", + "type": "string", + "required": false, + "summary": "Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster." + }, + { + "role": "flag", + "name": "keep-alive", + "type": "string", + "required": false, + "summary": "Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period." + }, + { + "role": "flag", + "name": "keep-on-completion", + "type": "boolean", + "required": false, + "summary": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`." + }, + { + "role": "flag", + "name": "allow-no-indices", + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." + }, + { + "role": "flag", + "name": "allow-partial-search-results", + "type": "boolean", + "required": false, + "summary": "Indicate if an error should be returned if there is a partial search failure or timeout" + }, + { + "role": "flag", + "name": "analyzer", + "type": "string", + "required": false, + "summary": "The analyzer to use for the query string" + }, + { + "role": "flag", + "name": "analyze-wildcard", + "type": "boolean", + "required": false, + "summary": "Specify whether wildcard and prefix queries should be analyzed" + }, + { + "role": "flag", + "name": "batched-reduce-size", + "type": "number", + "required": false, + "summary": "Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default)." + }, + { + "role": "flag", + "name": "ccs-minimize-roundtrips", + "type": "boolean", + "required": false, + "summary": "The default value is the only supported value." + }, + { + "role": "flag", + "name": "default-operator", + "type": "string", + "required": false, + "summary": "The default operator for query string query (AND or OR)" + }, + { + "role": "flag", + "name": "df", + "type": "string", + "required": false, + "summary": "The field to use as default where no field prefix is given in the query string" + }, + { + "role": "flag", + "name": "expand-wildcards", + "type": "string", + "required": false, + "summary": "Whether to expand wildcard expression to concrete indices that are open, closed or both", + "repeatable": true + }, + { + "role": "flag", + "name": "ignore-throttled", + "type": "boolean", + "required": false, + "summary": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" + }, + { + "role": "flag", + "name": "ignore-unavailable", + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." + }, + { + "role": "flag", + "name": "lenient", + "type": "boolean", + "required": false, + "summary": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" + }, + { + "role": "flag", + "name": "max-concurrent-shard-requests", + "type": "number", + "required": false, + "summary": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests" + }, + { + "role": "flag", + "name": "preference", + "type": "string", + "required": false, + "summary": "Specify the node or shard the operation should be performed on" + }, + { + "role": "flag", + "name": "request-cache", + "type": "boolean", + "required": false, + "summary": "Specify if request cache should be used for this request or not, defaults to true" + }, + { + "role": "flag", + "name": "routing", + "type": "string", + "required": false, + "summary": "A comma-separated list of specific routing values", + "repeatable": true + }, + { + "role": "flag", + "name": "search-type", + "type": "string", + "required": false, + "summary": "Search operation type" + }, + { + "role": "flag", + "name": "suggest-field", + "type": "string", + "required": false, + "summary": "Specifies which field to use for suggestions." + }, + { + "role": "flag", + "name": "suggest-mode", + "type": "string", + "required": false, + "summary": "Specify suggest mode" + }, + { + "role": "flag", + "name": "suggest-size", + "type": "number", + "required": false, + "summary": "How many suggestions to return in response" + }, + { + "role": "flag", + "name": "suggest-text", + "type": "string", + "required": false, + "summary": "The source text for which the suggestions should be returned." + }, + { + "role": "flag", + "name": "typed-keys", + "type": "boolean", + "required": false, + "summary": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" + }, + { + "role": "flag", + "name": "rest-total-hits-as-int", + "type": "boolean", + "required": false, + "summary": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response" + }, + { + "role": "flag", + "name": "source-excludes", + "type": "string", + "required": false, + "summary": "A list of fields to exclude from the returned _source field", + "repeatable": true + }, + { + "role": "flag", + "name": "source-includes", + "type": "string", + "required": false, + "summary": "A list of fields to extract and return from the _source field", + "repeatable": true + }, + { + "role": "flag", + "name": "q", + "type": "string", + "required": false, + "summary": "Query in the Lucene query string syntax" + }, + { + "role": "flag", + "name": "aggregations", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "aggs", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "collapse", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "explain", + "type": "boolean", + "required": false, + "summary": "If true, returns detailed information about score computation as part of a hit." + }, + { + "role": "flag", + "name": "ext", + "type": "string", + "required": false, + "summary": "Configuration of search extensions defined by Elasticsearch plugins." + }, + { + "role": "flag", + "name": "from", + "type": "number", + "required": false, + "summary": "Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter." + }, + { + "role": "flag", + "name": "highlight", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "track-total-hits", + "type": "boolean", + "required": false, + "summary": "Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits." + }, + { + "role": "flag", + "name": "indices-boost", + "type": "array", + "required": false, + "summary": "Boosts the _score of documents from specified indices." + }, + { + "role": "flag", + "name": "docvalue-fields", + "type": "array", + "required": false, + "summary": "Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response." + }, + { + "role": "flag", + "name": "knn", + "type": "string", + "required": false, + "summary": "Defines the approximate kNN search to run.", + "repeatable": true, + "separator": "," + }, + { + "role": "flag", + "name": "min-score", + "type": "number", + "required": false, + "summary": "Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations." + }, + { + "role": "flag", + "name": "post-filter", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "profile", + "type": "boolean", + "required": false + }, + { + "role": "flag", + "name": "query", + "type": "string", + "required": false, + "summary": "Defines the search definition using the Query DSL." + }, + { + "role": "flag", + "name": "rescore", + "type": "string", + "required": false, + "repeatable": true, + "separator": "," + }, + { + "role": "flag", + "name": "script-fields", + "type": "string", + "required": false, + "summary": "Retrieve a script evaluation (based on different fields) for each hit." + }, + { + "role": "flag", + "name": "search-after", + "type": "array", + "required": false + }, + { + "role": "flag", + "name": "size", + "type": "number", + "required": false, + "summary": "The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter." + }, + { + "role": "flag", + "name": "slice", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "sort", + "type": "string", + "required": false, + "repeatable": true, + "separator": "," + }, + { + "role": "flag", + "name": "source", + "type": "boolean", + "required": false, + "summary": "Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response." + }, + { + "role": "flag", + "name": "fields", + "type": "array", + "required": false, + "summary": "Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response." + }, + { + "role": "flag", + "name": "suggest", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "terminate-after", + "type": "number", + "required": false, + "summary": "Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early." + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout." + }, + { + "role": "flag", + "name": "track-scores", + "type": "boolean", + "required": false, + "summary": "If true, calculate and return document scores, even if the scores are not used for sorting." + }, + { + "role": "flag", + "name": "version", + "type": "boolean", + "required": false, + "summary": "If true, returns document version as part of a hit." + }, + { + "role": "flag", + "name": "seq-no-primary-term", + "type": "boolean", + "required": false, + "summary": "If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control." + }, + { + "role": "flag", + "name": "stored-fields", + "type": "string", + "required": false, + "summary": "List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.", + "repeatable": true, + "separator": "," + }, + { + "role": "flag", + "name": "pit", + "type": "string", + "required": false, + "summary": "Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path." + }, + { + "role": "flag", + "name": "runtime-mappings", + "type": "string", + "required": false, + "summary": "Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name." + }, + { + "role": "flag", + "name": "stats", + "type": "array", + "required": false, + "summary": "Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Run an async search.", + "intent": { + "requiresAuth": true + } + } + ], + "namespaces": [], + "summary": "Elasticsearch async-search API commands" + }, + { + "segment": "cat", + "commands": [ + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "aliases", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": false, + "summary": "A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "expand-wildcards", + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.", + "repeatable": true + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get aliases.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "allocation", + "parameters": [ + { + "role": "flag", + "name": "node-id", + "type": "string", + "required": false, + "summary": "A comma-separated list of node identifiers or names used to limit the returned information.", + "repeatable": true + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get shard allocation information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "circuit-breaker", + "parameters": [ + { + "role": "flag", + "name": "circuit-breaker-patterns", + "type": "string", + "required": false, + "summary": "A comma-separated list of regular-expressions to filter the circuit breakers in the output", + "repeatable": true + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get circuit breakers statistics.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "component-templates", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": false, + "summary": "The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get component templates.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "count", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get a document count.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "fielddata", + "parameters": [ + { + "role": "flag", + "name": "fields", + "type": "string", + "required": false, + "summary": "Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.", + "repeatable": true + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get field data cache information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "health", + "parameters": [ + { + "role": "flag", + "name": "ts", + "type": "boolean", + "required": false, + "summary": "If true, returns `HH:MM:SS` and Unix epoch timestamps." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get the cluster health status.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "help", + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get CAT help.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "indices", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "expand-wildcards", + "type": "string", + "required": false, + "summary": "The type of index that wildcard patterns can match.", + "repeatable": true + }, + { + "role": "flag", + "name": "health", + "type": "string", + "required": false, + "summary": "The health status used to limit returned indices. By default, the response includes indices of any health status." + }, + { + "role": "flag", + "name": "include-unloaded-segments", + "type": "boolean", + "required": false, + "summary": "If true, the response includes information from segments that are not loaded into memory." + }, + { + "role": "flag", + "name": "pri", + "type": "boolean", + "required": false, + "summary": "If true, the response only includes information from primary shards." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get index information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "master", + "parameters": [ + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get master node information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "ml-data-frame-analytics", + "parameters": [ + { + "role": "flag", + "name": "id", + "type": "string", + "required": false, + "summary": "The ID of the data frame analytics to fetch" + }, + { + "role": "flag", + "name": "allow-no-match", + "type": "boolean", + "required": false, + "summary": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified.)" + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "Comma-separated list of column names to display.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "Comma-separated list of column names or column aliases used to sort the response.", + "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get data frame analytics jobs.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "ml-datafeeds", + "parameters": [ + { + "role": "flag", + "name": "datafeed-id", + "type": "string", + "required": false, + "summary": "A numerical character string that uniquely identifies the datafeed." + }, + { + "role": "flag", + "name": "allow-no-match", + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "Comma-separated list of column names to display.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "Comma-separated list of column names or column aliases used to sort the response.", + "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get datafeeds.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "ml-jobs", + "parameters": [ + { + "role": "flag", + "name": "job-id", + "type": "string", + "required": false, + "summary": "Identifier for the anomaly detection job." + }, + { + "role": "flag", + "name": "allow-no-match", + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "Comma-separated list of column names to display.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "Comma-separated list of column names or column aliases used to sort the response.", + "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get anomaly detection jobs.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "ml-trained-models", + "parameters": [ + { + "role": "flag", + "name": "model-id", + "type": "string", + "required": false, + "summary": "A unique identifier for the trained model." + }, + { + "role": "flag", + "name": "allow-no-match", + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of column names to display.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "A comma-separated list of column names or aliases used to sort the response.", + "repeatable": true + }, + { + "role": "flag", + "name": "from", + "type": "number", + "required": false, + "summary": "Skips the specified number of transforms." + }, + { + "role": "flag", + "name": "size", + "type": "number", + "required": false, + "summary": "The maximum number of transforms to display." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get trained models.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "nodeattrs", + "parameters": [ + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get node attribute information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "nodes", + "parameters": [ + { + "role": "flag", + "name": "full-id", + "type": "boolean", + "required": false, + "summary": "If `true`, return the full node ID. If `false`, return the shortened node ID." + }, + { + "role": "flag", + "name": "include-unloaded-segments", + "type": "boolean", + "required": false, + "summary": "If true, the response includes information from segments that are not loaded into memory." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get node information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "pending-tasks", + "parameters": [ + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get pending task information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "plugins", + "parameters": [ + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "include-bootstrap", + "type": "boolean", + "required": false, + "summary": "Include bootstrap plugins in the response" + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get plugin information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "recovery", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "active-only", + "type": "boolean", + "required": false, + "summary": "If `true`, the response only includes ongoing shard recoveries." + }, + { + "role": "flag", + "name": "detailed", + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes detailed information about shard recoveries." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get shard recovery information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "repositories", + "parameters": [ + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "List of columns to appear in the response. Supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get snapshot repository information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "segments", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "expand-wildcards", + "type": "string", + "required": false, + "summary": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.", + "repeatable": true + }, + { + "role": "flag", + "name": "allow-no-indices", + "type": "boolean", + "required": false, + "summary": "A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result." + }, + { + "role": "flag", + "name": "ignore-throttled", + "type": "boolean", + "required": false, + "summary": "If true, concrete, expanded or aliased indices are ignored when frozen." + }, + { + "role": "flag", + "name": "ignore-unavailable", + "type": "boolean", + "required": false, + "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." + }, + { + "role": "flag", + "name": "allow-closed", + "type": "boolean", + "required": false, + "summary": "If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get segment information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "shards", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "repeatable": true + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "List of columns to appear in the response. Supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get shard information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "snapshots", + "parameters": [ + { + "role": "flag", + "name": "repository", + "type": "string", + "required": false, + "summary": "A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, Elasticsearch returns an error.", + "repeatable": true + }, + { + "role": "flag", + "name": "ignore-unavailable", + "type": "boolean", + "required": false, + "summary": "If `true`, the response does not include information from unavailable snapshots." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get snapshot information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "tasks", + "parameters": [ + { + "role": "flag", + "name": "actions", + "type": "array", + "required": false, + "summary": "The task action names, which are used to limit the response." + }, + { + "role": "flag", + "name": "detailed", + "type": "boolean", + "required": false, + "summary": "If `true`, the response includes detailed information about shard recoveries." + }, + { + "role": "flag", + "name": "nodes", + "type": "array", + "required": false, + "summary": "Unique node identifiers, which are used to limit the response." + }, + { + "role": "flag", + "name": "parent-task-id", + "type": "string", + "required": false, + "summary": "The parent task identifier, which is used to limit the response." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "wait-for-completion", + "type": "boolean", + "required": false, + "summary": "If `true`, the request blocks until the task has completed." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get task information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "templates", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": false, + "summary": "The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "A comma-separated list of columns names to display. It supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get index template information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "thread-pool", + "parameters": [ + { + "role": "flag", + "name": "thread-pool-patterns", + "type": "string", + "required": false, + "summary": "A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.", + "repeatable": true + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "List of columns to appear in the response. Supports simple wildcards.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", + "repeatable": true + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get thread pool statistics.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cat" + ], + "name": "transforms", + "parameters": [ + { + "role": "flag", + "name": "transform-id", + "type": "string", + "required": false, + "summary": "A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms." + }, + { + "role": "flag", + "name": "allow-no-match", + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches." + }, + { + "role": "flag", + "name": "from", + "type": "number", + "required": false, + "summary": "Skips the specified number of transforms." + }, + { + "role": "flag", + "name": "h", + "type": "string", + "required": false, + "summary": "Comma-separated list of column names to display.", + "repeatable": true + }, + { + "role": "flag", + "name": "s", + "type": "string", + "required": false, + "summary": "Comma-separated list of column names or column aliases used to sort the response.", + "repeatable": true + }, + { + "role": "flag", + "name": "size", + "type": "number", + "required": false, + "summary": "The maximum number of transforms to obtain." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get transform information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + } + ], + "namespaces": [], + "summary": "Elasticsearch cat API commands" + }, + { + "segment": "ccr", + "commands": [ + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "delete-auto-follow-pattern", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": true, + "summary": "The auto-follow pattern collection to delete." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Delete auto-follow patterns.", + "intent": { + "destructive": true, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "follow", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "The name of the follower index." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "wait-for-active-shards", + "type": "number", + "required": false, + "summary": "Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be active. A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the remote Lucene segment files to the follower index." + }, + { + "role": "flag", + "name": "data-stream-name", + "type": "string", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "leader-index", + "type": "string", + "required": true, + "summary": "The name of the index in the leader cluster to follow." + }, + { + "role": "flag", + "name": "max-outstanding-read-requests", + "type": "number", + "required": false, + "summary": "The maximum number of outstanding reads requests from the remote cluster." + }, + { + "role": "flag", + "name": "max-outstanding-write-requests", + "type": "number", + "required": false, + "summary": "The maximum number of outstanding write requests on the follower." + }, + { + "role": "flag", + "name": "max-read-request-operation-count", + "type": "number", + "required": false, + "summary": "The maximum number of operations to pull per read from the remote cluster." + }, + { + "role": "flag", + "name": "max-read-request-size", + "type": "number", + "required": false, + "summary": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster." + }, + { + "role": "flag", + "name": "max-retry-delay", + "type": "string", + "required": false, + "summary": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying." + }, + { + "role": "flag", + "name": "max-write-buffer-count", + "type": "number", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "max-write-buffer-size", + "type": "number", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "max-write-request-operation-count", + "type": "number", + "required": false, + "summary": "The maximum number of operations per bulk write request executed on the follower." + }, + { + "role": "flag", + "name": "max-write-request-size", + "type": "number", + "required": false, + "summary": "The maximum total bytes of operations per bulk write request executed on the follower." + }, + { + "role": "flag", + "name": "read-poll-timeout", + "type": "string", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "remote-cluster", + "type": "string", + "required": true, + "summary": "The remote cluster containing the leader index." + }, + { + "role": "flag", + "name": "settings", + "type": "string", + "required": false, + "summary": "Settings to override from the leader index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Create a follower.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "follow-info", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "A comma-delimited list of follower index patterns.", + "repeatable": true + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get follower information.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "follow-stats", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "A comma-delimited list of index patterns.", + "repeatable": true + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get follower stats.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "forget-follower", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "Name of the leader index for which specified follower retention leases should be removed" + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "follower-cluster", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "follower-index", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "follower-index-uuid", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "leader-remote-cluster", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Forget a follower.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "get-auto-follow-pattern", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": false, + "summary": "The auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get auto-follow patterns.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "pause-auto-follow-pattern", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": true, + "summary": "The name of the auto-follow pattern to pause." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Pause an auto-follow pattern.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "pause-follow", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "The name of the follower index." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Pause a follower.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "put-auto-follow-pattern", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": true, + "summary": "The name of the collection of auto-follow patterns." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "remote-cluster", + "type": "string", + "required": true, + "summary": "The remote cluster containing the leader indices to match against." + }, + { + "role": "flag", + "name": "follow-index-pattern", + "type": "string", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "leader-index-patterns", + "type": "array", + "required": false, + "summary": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field." + }, + { + "role": "flag", + "name": "leader-index-exclusion-patterns", + "type": "array", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "max-outstanding-read-requests", + "type": "number", + "required": false, + "summary": "The maximum number of outstanding reads requests from the remote cluster." + }, + { + "role": "flag", + "name": "settings", + "type": "string", + "required": false, + "summary": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards)." + }, + { + "role": "flag", + "name": "max-outstanding-write-requests", + "type": "number", + "required": false, + "summary": "The maximum number of outstanding reads requests from the remote cluster." + }, + { + "role": "flag", + "name": "read-poll-timeout", + "type": "string", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "max-read-request-operation-count", + "type": "number", + "required": false, + "summary": "The maximum number of operations to pull per read from the remote cluster." + }, + { + "role": "flag", + "name": "max-read-request-size", + "type": "number", + "required": false, + "summary": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster." + }, + { + "role": "flag", + "name": "max-retry-delay", + "type": "string", + "required": false, + "summary": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying." + }, + { + "role": "flag", + "name": "max-write-buffer-count", + "type": "number", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "max-write-buffer-size", + "type": "number", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "max-write-request-operation-count", + "type": "number", + "required": false, + "summary": "The maximum number of operations per bulk write request executed on the follower." + }, + { + "role": "flag", + "name": "max-write-request-size", + "type": "number", + "required": false, + "summary": "The maximum total bytes of operations per bulk write request executed on the follower." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Create or update auto-follow patterns.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "resume-auto-follow-pattern", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": true, + "summary": "The name of the auto-follow pattern to resume." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Resume an auto-follow pattern.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "resume-follow", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "Name of the follow index to resume following" + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "max-outstanding-read-requests", + "type": "number", + "required": false + }, + { + "role": "flag", + "name": "max-outstanding-write-requests", + "type": "number", + "required": false + }, + { + "role": "flag", + "name": "max-read-request-operation-count", + "type": "number", + "required": false + }, + { + "role": "flag", + "name": "max-read-request-size", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "max-retry-delay", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "max-write-buffer-count", + "type": "number", + "required": false + }, + { + "role": "flag", + "name": "max-write-buffer-size", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "max-write-request-operation-count", + "type": "number", + "required": false + }, + { + "role": "flag", + "name": "max-write-request-size", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "read-poll-timeout", + "type": "string", + "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Resume a follower.", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "stats", + "parameters": [ + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get cross-cluster replication stats.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "ccr" + ], + "name": "unfollow", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": true, + "summary": "The name of the follower index." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Unfollow an index.", + "intent": { + "requiresAuth": true + } + } + ], + "namespaces": [], + "summary": "Elasticsearch ccr API commands" + }, + { + "segment": "cluster", + "commands": [ + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "allocation-explain", + "parameters": [ + { + "role": "flag", + "name": "include-disk-info", + "type": "boolean", + "required": false, + "summary": "If true, returns information about disk usage and shard sizes." + }, + { + "role": "flag", + "name": "include-yes-decisions", + "type": "boolean", + "required": false, + "summary": "If true, returns YES decisions in explanation." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "The name of the index that you would like an explanation for." + }, + { + "role": "flag", + "name": "shard", + "type": "number", + "required": false, + "summary": "An identifier for the shard that you would like an explanation for." + }, + { + "role": "flag", + "name": "primary", + "type": "boolean", + "required": false, + "summary": "If true, returns an explanation for the primary shard for the specified shard ID." + }, + { + "role": "flag", + "name": "current-node", + "type": "string", + "required": false, + "summary": "Explain a shard only if it is currently located on the specified node name or node ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Explain the shard allocations.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "delete-component-template", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": true, + "summary": "Comma-separated list or wildcard expression of component template names used to limit the request.", + "repeatable": true + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Delete component templates.", + "intent": { + "destructive": true, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "delete-voting-config-exclusions", + "parameters": [ + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "wait-for-removal", + "type": "boolean", + "required": false, + "summary": "Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Clear cluster voting config exclusions.", + "intent": { + "destructive": true, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "exists-component-template", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": true, + "summary": "Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported.", + "repeatable": true + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Check component templates.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "get-component-template", + "parameters": [ + { + "role": "flag", + "name": "name", + "type": "string", + "required": false, + "summary": "Name of component template to retrieve. Wildcard (`*`) expressions are supported." + }, + { + "role": "flag", + "name": "flat-settings", + "type": "boolean", + "required": false, + "summary": "If `true`, returns settings in flat format." + }, + { + "role": "flag", + "name": "settings-filter", + "type": "string", + "required": false, + "summary": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys", + "repeatable": true + }, + { + "role": "flag", + "name": "include-defaults", + "type": "boolean", + "required": false, + "summary": "Return all default configurations for the component template" + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get component templates.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "get-settings", + "parameters": [ + { + "role": "flag", + "name": "flat-settings", + "type": "boolean", + "required": false, + "summary": "If `true`, returns settings in flat format." + }, + { + "role": "flag", + "name": "include-defaults", + "type": "boolean", + "required": false, + "summary": "If `true`, also returns the values of all other cluster settings set in the `elasticsearch.yml` file on one of the nodes in your cluster, together with the default values of all other cluster settings on that node. The default value of each setting may depend on the values of other settings on that node. If the nodes in your cluster do not all have the same configuration then the values returned by this API may vary from invocation to invocation and may not reflect the values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to fetch the settings for each individual node in your cluster." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "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." + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Get cluster-wide settings.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "cluster" + ], + "name": "health", + "parameters": [ + { + "role": "flag", + "name": "index", + "type": "string", + "required": false, + "summary": "A comma-separated list of data streams, indices, and index aliases that limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.", + "repeatable": true + }, + { + "role": "flag", + "name": "expand-wildcards", + "type": "string", + "required": false, + "summary": "Expand wildcard expression to concrete indices that are open, closed or both.", + "repeatable": true + }, + { + "role": "flag", + "name": "level", + "type": "string", + "required": false, + "summary": "Return health information at a specific level of detail." + }, + { + "role": "flag", + "name": "local", + "type": "boolean", + "required": false, + "summary": "If true, retrieve information from the local node only. If false, retrieve information from the master node." + }, + { + "role": "flag", + "name": "master-timeout", + "type": "string", + "required": false, + "summary": "The 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." + }, + { + "role": "flag", + "name": "timeout", + "type": "string", + "required": false, + "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "wait-for-active-shards", + "type": "number", + "required": false, + "summary": "Wait for the specified number of active shards. Use `all` to wait for all shards in the cluster to be active. Use `0` to not wait." + }, + { + "role": "flag", + "name": "wait-for-events", + "type": "string", + "required": false, + "summary": "Wait until all currently queued events with the given priority are processed." + }, + { + "role": "flag", + "name": "wait-for-nodes", + "type": "string", + "required": false, + "summary": "Wait until the specified number (N) of nodes is available. It also accepts `>=N`, `<=N`, `>N` and `