diff --git a/.buildkite/package-lock.json b/.buildkite/package-lock.json
index 8d10b3c2b7bc1..92231d27ea50f 100644
--- a/.buildkite/package-lock.json
+++ b/.buildkite/package-lock.json
@@ -1515,9 +1515,9 @@
}
},
"node_modules/tslib": {
- "version": "2.4.0",
- "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz",
- "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ=="
+ "version": "2.8.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.0.tgz",
+ "integrity": "sha512-jWVzBLplnCmoaTr13V9dYbiQ99wvZRd0vNWaDRg+aVYRcjDF3nDksxFDE/+fkXnKhpnUUkmx5pK/v8mCtLVqZA=="
},
"node_modules/type-detect": {
"version": "4.0.8",
@@ -2742,9 +2742,9 @@
}
},
"tslib": {
- "version": "2.4.0",
- "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz",
- "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ=="
+ "version": "2.8.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.0.tgz",
+ "integrity": "sha512-jWVzBLplnCmoaTr13V9dYbiQ99wvZRd0vNWaDRg+aVYRcjDF3nDksxFDE/+fkXnKhpnUUkmx5pK/v8mCtLVqZA=="
},
"type-detect": {
"version": "4.0.8",
diff --git a/.buildkite/pipelines/fips.yml b/.buildkite/pipelines/fips.yml
index f4a5b3623bbcc..e04a5ecb8f936 100644
--- a/.buildkite/pipelines/fips.yml
+++ b/.buildkite/pipelines/fips.yml
@@ -40,14 +40,15 @@ steps:
machineType: n2-standard-2
preemptible: true
- - command: .buildkite/scripts/steps/fips/smoke_test.sh
- label: 'Pick Smoke Test Group Run Order'
+ - command: .buildkite/scripts/steps/test/pick_test_group_run_order.sh
+ label: 'Pick Test Group Run Order'
depends_on: build
timeout_in_minutes: 10
env:
FTR_CONFIGS_SCRIPT: '.buildkite/scripts/steps/test/ftr_configs.sh'
FTR_EXTRA_ARGS: '$FTR_EXTRA_ARGS'
- LIMIT_CONFIG_TYPE: 'functional'
+ JEST_UNIT_SCRIPT: '.buildkite/scripts/steps/test/jest.sh'
+ JEST_INTEGRATION_SCRIPT: '.buildkite/scripts/steps/test/jest_integration.sh'
retry:
automatic:
- exit_status: '*'
diff --git a/.buildkite/pipelines/on_merge.yml b/.buildkite/pipelines/on_merge.yml
index e5d28465b2dc3..66cc3f9f33042 100644
--- a/.buildkite/pipelines/on_merge.yml
+++ b/.buildkite/pipelines/on_merge.yml
@@ -493,6 +493,21 @@ steps:
- exit_status: '-1'
limit: 3
+ - command: .buildkite/scripts/steps/openapi_publishing/publish_oas_docs.sh
+ label: 'Publish OAS docs to bump.sh'
+ agents:
+ image: family/kibana-ubuntu-2004
+ imageProject: elastic-images-prod
+ provider: gcp
+ machineType: n2-standard-2
+ preemptible: true
+ timeout_in_minutes: 60
+ soft_fail: true
+ retry:
+ automatic:
+ - exit_status: '-1'
+ limit: 3
+
- command: .buildkite/scripts/steps/bazel_cache/bootstrap_linux.sh
label: 'Populate local dev bazel cache (Linux)'
agents:
diff --git a/.buildkite/scripts/common/env.sh b/.buildkite/scripts/common/env.sh
index 511f6ead2d43c..1eb86de0bc030 100755
--- a/.buildkite/scripts/common/env.sh
+++ b/.buildkite/scripts/common/env.sh
@@ -146,7 +146,7 @@ if [[ "${KBN_ENABLE_FIPS:-}" == "true" ]] || is_pr_with_label "ci:enable-fips-ag
fi
if [[ -f "$KIBANA_DIR/config/kibana.yml" ]]; then
- echo -e '\nxpack.security.experimental.fipsMode.enabled: true' >>"$KIBANA_DIR/config/kibana.yml"
+ echo -e '\nxpack.security.fipsMode.enabled: true' >>"$KIBANA_DIR/config/kibana.yml"
fi
fi
diff --git a/.buildkite/scripts/steps/fips/smoke_test.sh b/.buildkite/scripts/steps/fips/smoke_test.sh
deleted file mode 100755
index 685bb111ff81a..0000000000000
--- a/.buildkite/scripts/steps/fips/smoke_test.sh
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-
-# Limit the FTR configs for now to avoid running all the tests. Once we're
-# ready to utilize the full FTR suite in FIPS mode, we can remove this file and
-# call pick_test_group_run_order.sh directly in .buildkite/pipelines/fips.yml.
-configs=(
- "x-pack/test/reporting_functional/reporting_and_security.config.ts"
- "x-pack/test/saved_object_api_integration/security_and_spaces/config_trial.ts"
- "x-pack/test/alerting_api_integration/security_and_spaces/group1/config.ts"
- "x-pack/test/alerting_api_integration/security_and_spaces/group2/config.ts"
- "x-pack/test/alerting_api_integration/security_and_spaces/group3/config.ts"
- "x-pack/test/alerting_api_integration/security_and_spaces/group4/config.ts"
- "x-pack/test/functional/apps/saved_objects_management/config.ts"
- "x-pack/test/functional/apps/user_profiles/config.ts"
- "x-pack/test/functional/apps/security/config.ts"
-)
-
-printf -v FTR_CONFIG_PATTERNS '%s,' "${configs[@]}"
-FTR_CONFIG_PATTERNS="${FTR_CONFIG_PATTERNS%,}"
-export FTR_CONFIG_PATTERNS
-
-.buildkite/scripts/steps/test/pick_test_group_run_order.sh
diff --git a/.buildkite/scripts/steps/openapi_bundling/final_merge.sh b/.buildkite/scripts/steps/openapi_bundling/final_merge.sh
index 83dba04c350d2..fdd6a17e778fd 100755
--- a/.buildkite/scripts/steps/openapi_bundling/final_merge.sh
+++ b/.buildkite/scripts/steps/openapi_bundling/final_merge.sh
@@ -4,8 +4,16 @@ set -euo pipefail
source .buildkite/scripts/common/util.sh
+cur_dir=$(pwd)
+cd oas_docs
+
+echo --- Installing NPM modules
+npm install
+
echo --- Merge Kibana OpenAPI specs
+make api-docs
+# make api-docs-lint <-- Relies on JSONPath version with RCE vulnerabilities based on `npm audit`, https://github.com/advisories/GHSA-pppg-cpfq-h7wr
-(cd oas_docs && make api-docs && make api-docs-lint)
+cd "$cur_dir"
check_for_changed_files "make api-docs" true
diff --git a/.buildkite/scripts/steps/openapi_publishing/package-lock.json b/.buildkite/scripts/steps/openapi_publishing/package-lock.json
new file mode 100644
index 0000000000000..de64cc35aded2
--- /dev/null
+++ b/.buildkite/scripts/steps/openapi_publishing/package-lock.json
@@ -0,0 +1,1841 @@
+{
+ "name": "serverless",
+ "version": "1.0.0",
+ "lockfileVersion": 3,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "serverless",
+ "version": "1.0.0",
+ "license": "ISC",
+ "dependencies": {
+ "bump-cli": "^2.8.4"
+ }
+ },
+ "node_modules/@apidevtools/json-schema-ref-parser": {
+ "version": "9.1.2",
+ "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz",
+ "integrity": "sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==",
+ "dependencies": {
+ "@jsdevtools/ono": "^7.1.3",
+ "@types/json-schema": "^7.0.6",
+ "call-me-maybe": "^1.0.1",
+ "js-yaml": "^4.1.0"
+ }
+ },
+ "node_modules/@asyncapi/specs": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/@asyncapi/specs/-/specs-5.1.0.tgz",
+ "integrity": "sha512-yffhETqehkim43luMnPKOwzY0D0YtU4bKpORIXIaid6p5Y5kDLrMGJaEPkNieQp03HMjhjFrnUPtT8kvqe0+aQ==",
+ "dependencies": {
+ "@types/json-schema": "^7.0.11"
+ }
+ },
+ "node_modules/@clack/core": {
+ "version": "0.3.4",
+ "resolved": "https://registry.npmjs.org/@clack/core/-/core-0.3.4.tgz",
+ "integrity": "sha512-H4hxZDXgHtWTwV3RAVenqcC4VbJZNegbBjlPvzOzCouXtS2y3sDvlO3IsbrPNWuLWPPlYVYPghQdSF64683Ldw==",
+ "dependencies": {
+ "picocolors": "^1.0.0",
+ "sisteransi": "^1.0.5"
+ }
+ },
+ "node_modules/@clack/prompts": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/@clack/prompts/-/prompts-0.6.3.tgz",
+ "integrity": "sha512-AM+kFmAHawpUQv2q9+mcB6jLKxXGjgu/r2EQjEwujgpCdzrST6BJqYw00GRn56/L/Izw5U7ImoLmy00X/r80Pw==",
+ "bundleDependencies": [
+ "is-unicode-supported"
+ ],
+ "dependencies": {
+ "@clack/core": "^0.3.2",
+ "is-unicode-supported": "*",
+ "picocolors": "^1.0.0",
+ "sisteransi": "^1.0.5"
+ }
+ },
+ "node_modules/@clack/prompts/node_modules/is-unicode-supported": {
+ "version": "1.3.0",
+ "inBundle": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/@cspotcode/source-map-support": {
+ "version": "0.8.1",
+ "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz",
+ "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==",
+ "dependencies": {
+ "@jridgewell/trace-mapping": "0.3.9"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@jridgewell/resolve-uri": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz",
+ "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==",
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/@jridgewell/sourcemap-codec": {
+ "version": "1.5.0",
+ "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz",
+ "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ=="
+ },
+ "node_modules/@jridgewell/trace-mapping": {
+ "version": "0.3.9",
+ "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz",
+ "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==",
+ "dependencies": {
+ "@jridgewell/resolve-uri": "^3.0.3",
+ "@jridgewell/sourcemap-codec": "^1.4.10"
+ }
+ },
+ "node_modules/@jsdevtools/ono": {
+ "version": "7.1.3",
+ "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz",
+ "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg=="
+ },
+ "node_modules/@nodelib/fs.scandir": {
+ "version": "2.1.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
+ "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
+ "dependencies": {
+ "@nodelib/fs.stat": "2.0.5",
+ "run-parallel": "^1.1.9"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.stat": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
+ "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.walk": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
+ "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
+ "dependencies": {
+ "@nodelib/fs.scandir": "2.1.5",
+ "fastq": "^1.6.0"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@oclif/command": {
+ "version": "1.8.36",
+ "resolved": "https://registry.npmjs.org/@oclif/command/-/command-1.8.36.tgz",
+ "integrity": "sha512-/zACSgaYGtAQRzc7HjzrlIs14FuEYAZrMOEwicRoUnZVyRunG4+t5iSEeQu0Xy2bgbCD0U1SP/EdeNZSTXRwjQ==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/config": "^1.18.2",
+ "@oclif/errors": "^1.3.6",
+ "@oclif/help": "^1.0.1",
+ "@oclif/parser": "^3.8.17",
+ "debug": "^4.1.1",
+ "semver": "^7.5.4"
+ },
+ "engines": {
+ "node": ">=12.0.0"
+ },
+ "peerDependencies": {
+ "@oclif/config": "^1"
+ }
+ },
+ "node_modules/@oclif/config": {
+ "version": "1.18.17",
+ "resolved": "https://registry.npmjs.org/@oclif/config/-/config-1.18.17.tgz",
+ "integrity": "sha512-k77qyeUvjU8qAJ3XK3fr/QVAqsZO8QOBuESnfeM5HHtPNLSyfVcwiMM2zveSW5xRdLSG3MfV8QnLVkuyCL2ENg==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/errors": "^1.3.6",
+ "@oclif/parser": "^3.8.17",
+ "debug": "^4.3.4",
+ "globby": "^11.1.0",
+ "is-wsl": "^2.1.1",
+ "tslib": "^2.6.1"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/core": {
+ "version": "1.20.4",
+ "resolved": "https://registry.npmjs.org/@oclif/core/-/core-1.20.4.tgz",
+ "integrity": "sha512-giug32M4YhSYNYKQwE1L57/+k5gp1+Bq3/0vKNQmzAY1tizFGhvBJc6GIRZasHjU+xtZLutQvrVrJo7chX3hxg==",
+ "dependencies": {
+ "@oclif/linewrap": "^1.0.0",
+ "@oclif/screen": "^3.0.3",
+ "ansi-escapes": "^4.3.2",
+ "ansi-styles": "^4.3.0",
+ "cardinal": "^2.1.1",
+ "chalk": "^4.1.2",
+ "clean-stack": "^3.0.1",
+ "cli-progress": "^3.10.0",
+ "debug": "^4.3.4",
+ "ejs": "^3.1.6",
+ "fs-extra": "^9.1.0",
+ "get-package-type": "^0.1.0",
+ "globby": "^11.1.0",
+ "hyperlinker": "^1.0.0",
+ "indent-string": "^4.0.0",
+ "is-wsl": "^2.2.0",
+ "js-yaml": "^3.14.1",
+ "natural-orderby": "^2.0.3",
+ "object-treeify": "^1.1.33",
+ "password-prompt": "^1.1.2",
+ "semver": "^7.3.7",
+ "string-width": "^4.2.3",
+ "strip-ansi": "^6.0.1",
+ "supports-color": "^8.1.1",
+ "supports-hyperlinks": "^2.2.0",
+ "tslib": "^2.4.1",
+ "widest-line": "^3.1.0",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=14.0.0"
+ }
+ },
+ "node_modules/@oclif/core/node_modules/argparse": {
+ "version": "1.0.10",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
+ "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
+ "dependencies": {
+ "sprintf-js": "~1.0.2"
+ }
+ },
+ "node_modules/@oclif/core/node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@oclif/core/node_modules/js-yaml": {
+ "version": "3.14.1",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
+ "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
+ "dependencies": {
+ "argparse": "^1.0.7",
+ "esprima": "^4.0.0"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/@oclif/errors": {
+ "version": "1.3.6",
+ "resolved": "https://registry.npmjs.org/@oclif/errors/-/errors-1.3.6.tgz",
+ "integrity": "sha512-fYaU4aDceETd89KXP+3cLyg9EHZsLD3RxF2IU9yxahhBpspWjkWi3Dy3bTgcwZ3V47BgxQaGapzJWDM33XIVDQ==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "clean-stack": "^3.0.0",
+ "fs-extra": "^8.1",
+ "indent-string": "^4.0.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/errors/node_modules/fs-extra": {
+ "version": "8.1.0",
+ "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz",
+ "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==",
+ "dependencies": {
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^4.0.0",
+ "universalify": "^0.1.0"
+ },
+ "engines": {
+ "node": ">=6 <7 || >=8"
+ }
+ },
+ "node_modules/@oclif/errors/node_modules/jsonfile": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
+ "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==",
+ "optionalDependencies": {
+ "graceful-fs": "^4.1.6"
+ }
+ },
+ "node_modules/@oclif/errors/node_modules/universalify": {
+ "version": "0.1.2",
+ "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",
+ "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==",
+ "engines": {
+ "node": ">= 4.0.0"
+ }
+ },
+ "node_modules/@oclif/help": {
+ "version": "1.0.15",
+ "resolved": "https://registry.npmjs.org/@oclif/help/-/help-1.0.15.tgz",
+ "integrity": "sha512-Yt8UHoetk/XqohYX76DfdrUYLsPKMc5pgkzsZVHDyBSkLiGRzujVaGZdjr32ckVZU9q3a47IjhWxhip7Dz5W/g==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/config": "1.18.16",
+ "@oclif/errors": "1.3.6",
+ "chalk": "^4.1.2",
+ "indent-string": "^4.0.0",
+ "lodash": "^4.17.21",
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.0",
+ "widest-line": "^3.1.0",
+ "wrap-ansi": "^6.2.0"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/help/node_modules/@oclif/config": {
+ "version": "1.18.16",
+ "resolved": "https://registry.npmjs.org/@oclif/config/-/config-1.18.16.tgz",
+ "integrity": "sha512-VskIxVcN22qJzxRUq+raalq6Q3HUde7sokB7/xk5TqRZGEKRVbFeqdQBxDWwQeudiJEgcNiMvIFbMQ43dY37FA==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/errors": "^1.3.6",
+ "@oclif/parser": "^3.8.16",
+ "debug": "^4.3.4",
+ "globby": "^11.1.0",
+ "is-wsl": "^2.1.1",
+ "tslib": "^2.6.1"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/help/node_modules/wrap-ansi": {
+ "version": "6.2.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz",
+ "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@oclif/linewrap": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/@oclif/linewrap/-/linewrap-1.0.0.tgz",
+ "integrity": "sha512-Ups2dShK52xXa8w6iBWLgcjPJWjais6KPJQq3gQ/88AY6BXoTX+MIGFPrWQO1KLMiQfoTpcLnUwloN4brrVUHw=="
+ },
+ "node_modules/@oclif/parser": {
+ "version": "3.8.17",
+ "resolved": "https://registry.npmjs.org/@oclif/parser/-/parser-3.8.17.tgz",
+ "integrity": "sha512-l04iSd0xoh/16TGVpXb81Gg3z7tlQGrEup16BrVLsZBK6SEYpYHRJZnM32BwZrHI97ZSFfuSwVlzoo6HdsaK8A==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/errors": "^1.3.6",
+ "@oclif/linewrap": "^1.0.0",
+ "chalk": "^4.1.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/plugin-help": {
+ "version": "5.2.20",
+ "resolved": "https://registry.npmjs.org/@oclif/plugin-help/-/plugin-help-5.2.20.tgz",
+ "integrity": "sha512-u+GXX/KAGL9S10LxAwNUaWdzbEBARJ92ogmM7g3gDVud2HioCmvWQCDohNRVZ9GYV9oKwZ/M8xwd6a1d95rEKQ==",
+ "dependencies": {
+ "@oclif/core": "^2.15.0"
+ },
+ "engines": {
+ "node": ">=12.0.0"
+ }
+ },
+ "node_modules/@oclif/plugin-help/node_modules/@oclif/core": {
+ "version": "2.16.0",
+ "resolved": "https://registry.npmjs.org/@oclif/core/-/core-2.16.0.tgz",
+ "integrity": "sha512-dL6atBH0zCZl1A1IXCKJgLPrM/wR7K+Wi401E/IvqsK8m2iCHW+0TEOGrans/cuN3oTW+uxIyJFHJ8Im0k4qBw==",
+ "dependencies": {
+ "@types/cli-progress": "^3.11.0",
+ "ansi-escapes": "^4.3.2",
+ "ansi-styles": "^4.3.0",
+ "cardinal": "^2.1.1",
+ "chalk": "^4.1.2",
+ "clean-stack": "^3.0.1",
+ "cli-progress": "^3.12.0",
+ "debug": "^4.3.4",
+ "ejs": "^3.1.8",
+ "get-package-type": "^0.1.0",
+ "globby": "^11.1.0",
+ "hyperlinker": "^1.0.0",
+ "indent-string": "^4.0.0",
+ "is-wsl": "^2.2.0",
+ "js-yaml": "^3.14.1",
+ "natural-orderby": "^2.0.3",
+ "object-treeify": "^1.1.33",
+ "password-prompt": "^1.1.2",
+ "slice-ansi": "^4.0.0",
+ "string-width": "^4.2.3",
+ "strip-ansi": "^6.0.1",
+ "supports-color": "^8.1.1",
+ "supports-hyperlinks": "^2.2.0",
+ "ts-node": "^10.9.1",
+ "tslib": "^2.5.0",
+ "widest-line": "^3.1.0",
+ "wordwrap": "^1.0.0",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=14.0.0"
+ }
+ },
+ "node_modules/@oclif/plugin-help/node_modules/argparse": {
+ "version": "1.0.10",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
+ "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
+ "dependencies": {
+ "sprintf-js": "~1.0.2"
+ }
+ },
+ "node_modules/@oclif/plugin-help/node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@oclif/plugin-help/node_modules/js-yaml": {
+ "version": "3.14.1",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
+ "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
+ "dependencies": {
+ "argparse": "^1.0.7",
+ "esprima": "^4.0.0"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/@oclif/screen": {
+ "version": "3.0.8",
+ "resolved": "https://registry.npmjs.org/@oclif/screen/-/screen-3.0.8.tgz",
+ "integrity": "sha512-yx6KAqlt3TAHBduS2fMQtJDL2ufIHnDRArrJEOoTTuizxqmjLT+psGYOHpmMl3gvQpFJ11Hs76guUUktzAF9Bg==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "engines": {
+ "node": ">=12.0.0"
+ }
+ },
+ "node_modules/@stoplight/ordered-object-literal": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/@stoplight/ordered-object-literal/-/ordered-object-literal-1.0.5.tgz",
+ "integrity": "sha512-COTiuCU5bgMUtbIFBuyyh2/yVVzlr5Om0v5utQDgBCuQUOPgU1DwoffkTfg4UBQOvByi5foF4w4T+H9CoRe5wg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@stoplight/types": {
+ "version": "14.1.1",
+ "resolved": "https://registry.npmjs.org/@stoplight/types/-/types-14.1.1.tgz",
+ "integrity": "sha512-/kjtr+0t0tjKr+heVfviO9FrU/uGLc+QNX3fHJc19xsCNYqU7lVhaXxDmEID9BZTjG+/r9pK9xP/xU02XGg65g==",
+ "dependencies": {
+ "@types/json-schema": "^7.0.4",
+ "utility-types": "^3.10.0"
+ },
+ "engines": {
+ "node": "^12.20 || >=14.13"
+ }
+ },
+ "node_modules/@stoplight/yaml": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/@stoplight/yaml/-/yaml-4.3.0.tgz",
+ "integrity": "sha512-JZlVFE6/dYpP9tQmV0/ADfn32L9uFarHWxfcRhReKUnljz1ZiUM5zpX+PH8h5CJs6lao3TuFqnPm9IJJCEkE2w==",
+ "dependencies": {
+ "@stoplight/ordered-object-literal": "^1.0.5",
+ "@stoplight/types": "^14.1.1",
+ "@stoplight/yaml-ast-parser": "0.0.50",
+ "tslib": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=10.8"
+ }
+ },
+ "node_modules/@stoplight/yaml-ast-parser": {
+ "version": "0.0.50",
+ "resolved": "https://registry.npmjs.org/@stoplight/yaml-ast-parser/-/yaml-ast-parser-0.0.50.tgz",
+ "integrity": "sha512-Pb6M8TDO9DtSVla9yXSTAxmo9GVEouq5P40DWXdOie69bXogZTkgvopCq+yEvTMA0F6PEvdJmbtTV3ccIp11VQ=="
+ },
+ "node_modules/@tsconfig/node10": {
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.11.tgz",
+ "integrity": "sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw=="
+ },
+ "node_modules/@tsconfig/node12": {
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz",
+ "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag=="
+ },
+ "node_modules/@tsconfig/node14": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz",
+ "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow=="
+ },
+ "node_modules/@tsconfig/node16": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz",
+ "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA=="
+ },
+ "node_modules/@types/cli-progress": {
+ "version": "3.11.6",
+ "resolved": "https://registry.npmjs.org/@types/cli-progress/-/cli-progress-3.11.6.tgz",
+ "integrity": "sha512-cE3+jb9WRlu+uOSAugewNpITJDt1VF8dHOopPO4IABFc3SXYL5WE/+PTz/FCdZRRfIujiWW3n3aMbv1eIGVRWA==",
+ "dependencies": {
+ "@types/node": "*"
+ }
+ },
+ "node_modules/@types/json-schema": {
+ "version": "7.0.15",
+ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
+ "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="
+ },
+ "node_modules/@types/node": {
+ "version": "22.8.1",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-22.8.1.tgz",
+ "integrity": "sha512-k6Gi8Yyo8EtrNtkHXutUu2corfDf9su95VYVP10aGYMMROM6SAItZi0w1XszA6RtWTHSVp5OeFof37w0IEqCQg==",
+ "dependencies": {
+ "undici-types": "~6.19.8"
+ }
+ },
+ "node_modules/acorn": {
+ "version": "8.14.0",
+ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.0.tgz",
+ "integrity": "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA==",
+ "bin": {
+ "acorn": "bin/acorn"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/acorn-walk": {
+ "version": "8.3.4",
+ "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz",
+ "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==",
+ "dependencies": {
+ "acorn": "^8.11.0"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/ansi-escapes": {
+ "version": "4.3.2",
+ "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz",
+ "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==",
+ "dependencies": {
+ "type-fest": "^0.21.3"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/ansicolors": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/ansicolors/-/ansicolors-0.3.2.tgz",
+ "integrity": "sha512-QXu7BPrP29VllRxH8GwB7x5iX5qWKAAMLqKQGWTeLWVlNHNOpVMJ91dsxQAIWXpjuW5wqvxu3Jd/nRjrJ+0pqg=="
+ },
+ "node_modules/arg": {
+ "version": "4.1.3",
+ "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz",
+ "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA=="
+ },
+ "node_modules/argparse": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+ },
+ "node_modules/array-union": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz",
+ "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/astral-regex": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz",
+ "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/async": {
+ "version": "3.2.6",
+ "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz",
+ "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA=="
+ },
+ "node_modules/async-mutex": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/async-mutex/-/async-mutex-0.4.1.tgz",
+ "integrity": "sha512-WfoBo4E/TbCX1G95XTjbWTE3X2XLG0m1Xbv2cwOtuPdyH9CZvnaA5nCt1ucjaKEgW2A5IF71hxrRhr83Je5xjA==",
+ "dependencies": {
+ "tslib": "^2.4.0"
+ }
+ },
+ "node_modules/asynckit": {
+ "version": "0.4.0",
+ "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
+ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q=="
+ },
+ "node_modules/at-least-node": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
+ "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==",
+ "engines": {
+ "node": ">= 4.0.0"
+ }
+ },
+ "node_modules/axios": {
+ "version": "1.7.7",
+ "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz",
+ "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==",
+ "dependencies": {
+ "follow-redirects": "^1.15.6",
+ "form-data": "^4.0.0",
+ "proxy-from-env": "^1.1.0"
+ }
+ },
+ "node_modules/balanced-match": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
+ "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="
+ },
+ "node_modules/brace-expansion": {
+ "version": "1.1.11",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
+ "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+ "dependencies": {
+ "balanced-match": "^1.0.0",
+ "concat-map": "0.0.1"
+ }
+ },
+ "node_modules/braces": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
+ "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
+ "dependencies": {
+ "fill-range": "^7.1.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/bump-cli": {
+ "version": "2.8.4",
+ "resolved": "https://registry.npmjs.org/bump-cli/-/bump-cli-2.8.4.tgz",
+ "integrity": "sha512-FwcsaY1jmCtwXkuIhkPxGLysLrxCJKnl54PHutb7N4FIuO9Hq8Xjn1giEfO3ZK8UGVZ9DiAb11H9ypFP6WNnhQ==",
+ "dependencies": {
+ "@apidevtools/json-schema-ref-parser": "^9.0.7",
+ "@asyncapi/specs": "^5.1.0",
+ "@clack/prompts": "^0.6.3",
+ "@oclif/command": "^1.8.36",
+ "@oclif/config": "^1.18.17",
+ "@oclif/core": "1.20.4",
+ "@oclif/plugin-help": "^5.1.10",
+ "@stoplight/yaml": "^4.2.3",
+ "async-mutex": "^0.4.0",
+ "axios": "^1.6.4",
+ "debug": "^4.3.1",
+ "jsonpath": "^1.1.1",
+ "mergician": "^1.0.3",
+ "oas-schemas": "git+https://git@github.com/OAI/OpenAPI-Specification.git#0f9d3ec7c033fef184ec54e1ffc201b2d61ce023",
+ "tslib": "^2.3.0"
+ },
+ "bin": {
+ "bump": "bin/run"
+ },
+ "engines": {
+ "node": ">=16.0.0"
+ }
+ },
+ "node_modules/call-me-maybe": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz",
+ "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ=="
+ },
+ "node_modules/cardinal": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/cardinal/-/cardinal-2.1.1.tgz",
+ "integrity": "sha512-JSr5eOgoEymtYHBjNWyjrMqet9Am2miJhlfKNdqLp6zoeAh0KN5dRAcxlecj5mAJrmQomgiOBj35xHLrFjqBpw==",
+ "dependencies": {
+ "ansicolors": "~0.3.2",
+ "redeyed": "~2.1.0"
+ },
+ "bin": {
+ "cdl": "bin/cdl.js"
+ }
+ },
+ "node_modules/chalk": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+ "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
+ "dependencies": {
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
+ }
+ },
+ "node_modules/chalk/node_modules/supports-color": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+ "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/clean-stack": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-3.0.1.tgz",
+ "integrity": "sha512-lR9wNiMRcVQjSB3a7xXGLuz4cr4wJuuXlaAEbRutGowQTmlp7R72/DOgN21e8jdwblMWl9UOJMJXarX94pzKdg==",
+ "dependencies": {
+ "escape-string-regexp": "4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/cli-progress": {
+ "version": "3.12.0",
+ "resolved": "https://registry.npmjs.org/cli-progress/-/cli-progress-3.12.0.tgz",
+ "integrity": "sha512-tRkV3HJ1ASwm19THiiLIXLO7Im7wlTuKnvkYaTkyoAPefqjNg7W7DHKUlGRxy9vxDvbyCYQkQozvptuMkGCg8A==",
+ "dependencies": {
+ "string-width": "^4.2.3"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "node_modules/combined-stream": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
+ "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
+ "dependencies": {
+ "delayed-stream": "~1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/concat-map": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
+ "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="
+ },
+ "node_modules/create-require": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",
+ "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ=="
+ },
+ "node_modules/cross-spawn": {
+ "version": "7.0.3",
+ "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
+ "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
+ "dependencies": {
+ "path-key": "^3.1.0",
+ "shebang-command": "^2.0.0",
+ "which": "^2.0.1"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/debug": {
+ "version": "4.3.7",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz",
+ "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==",
+ "dependencies": {
+ "ms": "^2.1.3"
+ },
+ "engines": {
+ "node": ">=6.0"
+ },
+ "peerDependenciesMeta": {
+ "supports-color": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/deep-is": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz",
+ "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ=="
+ },
+ "node_modules/delayed-stream": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
+ "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==",
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/diff": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz",
+ "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==",
+ "engines": {
+ "node": ">=0.3.1"
+ }
+ },
+ "node_modules/dir-glob": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz",
+ "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==",
+ "dependencies": {
+ "path-type": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ejs": {
+ "version": "3.1.10",
+ "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz",
+ "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==",
+ "dependencies": {
+ "jake": "^10.8.5"
+ },
+ "bin": {
+ "ejs": "bin/cli.js"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
+ },
+ "node_modules/escape-string-regexp": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
+ "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/escodegen": {
+ "version": "1.14.3",
+ "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.14.3.tgz",
+ "integrity": "sha512-qFcX0XJkdg+PB3xjZZG/wKSuT1PnQWx57+TVSjIMmILd2yC/6ByYElPwJnslDsuWuSAp4AwJGumarAAmJch5Kw==",
+ "dependencies": {
+ "esprima": "^4.0.1",
+ "estraverse": "^4.2.0",
+ "esutils": "^2.0.2",
+ "optionator": "^0.8.1"
+ },
+ "bin": {
+ "escodegen": "bin/escodegen.js",
+ "esgenerate": "bin/esgenerate.js"
+ },
+ "engines": {
+ "node": ">=4.0"
+ },
+ "optionalDependencies": {
+ "source-map": "~0.6.1"
+ }
+ },
+ "node_modules/escodegen/node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/esprima": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.2.2.tgz",
+ "integrity": "sha512-+JpPZam9w5DuJ3Q67SqsMGtiHKENSMRVoxvArfJZK01/BfLEObtZ6orJa/MtoGNR/rfMgp5837T41PAmTwAv/A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/estraverse": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz",
+ "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==",
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/esutils": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz",
+ "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/fast-glob": {
+ "version": "3.3.2",
+ "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz",
+ "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==",
+ "dependencies": {
+ "@nodelib/fs.stat": "^2.0.2",
+ "@nodelib/fs.walk": "^1.2.3",
+ "glob-parent": "^5.1.2",
+ "merge2": "^1.3.0",
+ "micromatch": "^4.0.4"
+ },
+ "engines": {
+ "node": ">=8.6.0"
+ }
+ },
+ "node_modules/fast-levenshtein": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz",
+ "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="
+ },
+ "node_modules/fastq": {
+ "version": "1.17.1",
+ "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz",
+ "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==",
+ "dependencies": {
+ "reusify": "^1.0.4"
+ }
+ },
+ "node_modules/filelist": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.4.tgz",
+ "integrity": "sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==",
+ "dependencies": {
+ "minimatch": "^5.0.1"
+ }
+ },
+ "node_modules/filelist/node_modules/brace-expansion": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
+ "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
+ "dependencies": {
+ "balanced-match": "^1.0.0"
+ }
+ },
+ "node_modules/filelist/node_modules/minimatch": {
+ "version": "5.1.6",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz",
+ "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==",
+ "dependencies": {
+ "brace-expansion": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/fill-range": {
+ "version": "7.1.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
+ "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
+ "dependencies": {
+ "to-regex-range": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/follow-redirects": {
+ "version": "1.15.9",
+ "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.9.tgz",
+ "integrity": "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==",
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://github.com/sponsors/RubenVerborgh"
+ }
+ ],
+ "engines": {
+ "node": ">=4.0"
+ },
+ "peerDependenciesMeta": {
+ "debug": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/form-data": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.1.tgz",
+ "integrity": "sha512-tzN8e4TX8+kkxGPK8D5u0FNmjPUjw3lwC9lSLxxoB/+GtsJG91CO8bSWy73APlgAZzZbXEYZJuxjkHH2w+Ezhw==",
+ "dependencies": {
+ "asynckit": "^0.4.0",
+ "combined-stream": "^1.0.8",
+ "mime-types": "^2.1.12"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/fs-extra": {
+ "version": "9.1.0",
+ "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
+ "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
+ "dependencies": {
+ "at-least-node": "^1.0.0",
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^6.0.1",
+ "universalify": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/get-package-type": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz",
+ "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==",
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/glob-parent": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+ "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
+ "dependencies": {
+ "is-glob": "^4.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/globby": {
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz",
+ "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==",
+ "dependencies": {
+ "array-union": "^2.1.0",
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.9",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/graceful-fs": {
+ "version": "4.2.11",
+ "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
+ "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ=="
+ },
+ "node_modules/has-flag": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
+ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/hyperlinker": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/hyperlinker/-/hyperlinker-1.0.0.tgz",
+ "integrity": "sha512-Ty8UblRWFEcfSuIaajM34LdPXIhbs1ajEX/BBPv24J+enSVaEVY63xQ6lTO9VRYS5LAoghIG0IDJ+p+IPzKUQQ==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/ignore": {
+ "version": "5.3.2",
+ "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz",
+ "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==",
+ "engines": {
+ "node": ">= 4"
+ }
+ },
+ "node_modules/indent-string": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz",
+ "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-docker": {
+ "version": "2.2.1",
+ "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz",
+ "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==",
+ "bin": {
+ "is-docker": "cli.js"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-glob": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+ "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+ "dependencies": {
+ "is-extglob": "^2.1.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/is-wsl": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz",
+ "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==",
+ "dependencies": {
+ "is-docker": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/isexe": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
+ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="
+ },
+ "node_modules/jake": {
+ "version": "10.9.2",
+ "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.2.tgz",
+ "integrity": "sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA==",
+ "dependencies": {
+ "async": "^3.2.3",
+ "chalk": "^4.0.2",
+ "filelist": "^1.0.4",
+ "minimatch": "^3.1.2"
+ },
+ "bin": {
+ "jake": "bin/cli.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/js-yaml": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+ "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+ "dependencies": {
+ "argparse": "^2.0.1"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/jsonfile": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
+ "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
+ "dependencies": {
+ "universalify": "^2.0.0"
+ },
+ "optionalDependencies": {
+ "graceful-fs": "^4.1.6"
+ }
+ },
+ "node_modules/jsonpath": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/jsonpath/-/jsonpath-1.1.1.tgz",
+ "integrity": "sha512-l6Cg7jRpixfbgoWgkrl77dgEj8RPvND0wMH6TwQmi9Qs4TFfS9u5cUFnbeKTwj5ga5Y3BTGGNI28k117LJ009w==",
+ "dependencies": {
+ "esprima": "1.2.2",
+ "static-eval": "2.0.2",
+ "underscore": "1.12.1"
+ }
+ },
+ "node_modules/levn": {
+ "version": "0.3.0",
+ "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz",
+ "integrity": "sha512-0OO4y2iOHix2W6ujICbKIaEQXvFQHue65vUG3pb5EUomzPI90z9hsA1VsO/dbIIpC53J8gxM9Q4Oho0jrCM/yA==",
+ "dependencies": {
+ "prelude-ls": "~1.1.2",
+ "type-check": "~0.3.2"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/lodash": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+ },
+ "node_modules/make-error": {
+ "version": "1.3.6",
+ "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
+ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw=="
+ },
+ "node_modules/merge2": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
+ "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/mergician": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/mergician/-/mergician-1.1.0.tgz",
+ "integrity": "sha512-FXbxzU6BBhGkV8XtUr8Sk015ZRaAALviit8Lle6OEgd1udX8wlu6tBeUMLGQGdz1MfHpAVNNQkXowyDnJuhXpA==",
+ "engines": {
+ "node": ">=10.0.0"
+ }
+ },
+ "node_modules/micromatch": {
+ "version": "4.0.8",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
+ "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
+ "dependencies": {
+ "braces": "^3.0.3",
+ "picomatch": "^2.3.1"
+ },
+ "engines": {
+ "node": ">=8.6"
+ }
+ },
+ "node_modules/mime-db": {
+ "version": "1.52.0",
+ "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz",
+ "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/mime-types": {
+ "version": "2.1.35",
+ "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz",
+ "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==",
+ "dependencies": {
+ "mime-db": "1.52.0"
+ },
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/minimatch": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+ "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
+ "dependencies": {
+ "brace-expansion": "^1.1.7"
+ },
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/ms": {
+ "version": "2.1.3",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
+ "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
+ },
+ "node_modules/natural-orderby": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/natural-orderby/-/natural-orderby-2.0.3.tgz",
+ "integrity": "sha512-p7KTHxU0CUrcOXe62Zfrb5Z13nLvPhSWR/so3kFulUQU0sgUll2Z0LwpsLN351eOOD+hRGu/F1g+6xDfPeD++Q==",
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/oas-schemas": {
+ "version": "2.0.0",
+ "resolved": "git+https://git@github.com/OAI/OpenAPI-Specification.git#0f9d3ec7c033fef184ec54e1ffc201b2d61ce023",
+ "integrity": "sha512-B0izsjJFhgA/KCQExAt7cfLyw42KD+r3NE7hKbkmGSqoe3gb57eMUXTlN4MwEicFR86Gno+h3OSnRcHfUlVubQ=="
+ },
+ "node_modules/object-treeify": {
+ "version": "1.1.33",
+ "resolved": "https://registry.npmjs.org/object-treeify/-/object-treeify-1.1.33.tgz",
+ "integrity": "sha512-EFVjAYfzWqWsBMRHPMAXLCDIJnpMhdWAqR7xG6M6a2cs6PMFpl/+Z20w9zDW4vkxOFfddegBKq9Rehd0bxWE7A==",
+ "engines": {
+ "node": ">= 10"
+ }
+ },
+ "node_modules/optionator": {
+ "version": "0.8.3",
+ "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz",
+ "integrity": "sha512-+IW9pACdk3XWmmTXG8m3upGUJst5XRGzxMRjXzAuJ1XnIFNvfhjjIuYkDvysnPQ7qzqVzLt78BCruntqRhWQbA==",
+ "dependencies": {
+ "deep-is": "~0.1.3",
+ "fast-levenshtein": "~2.0.6",
+ "levn": "~0.3.0",
+ "prelude-ls": "~1.1.2",
+ "type-check": "~0.3.2",
+ "word-wrap": "~1.2.3"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/password-prompt": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/password-prompt/-/password-prompt-1.1.3.tgz",
+ "integrity": "sha512-HkrjG2aJlvF0t2BMH0e2LB/EHf3Lcq3fNMzy4GYHcQblAvOl+QQji1Lx7WRBMqpVK8p+KR7bCg7oqAMXtdgqyw==",
+ "dependencies": {
+ "ansi-escapes": "^4.3.2",
+ "cross-spawn": "^7.0.3"
+ }
+ },
+ "node_modules/path-key": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
+ "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/path-type": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz",
+ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/picocolors": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz",
+ "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA=="
+ },
+ "node_modules/picomatch": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==",
+ "engines": {
+ "node": ">=8.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/jonschlinkert"
+ }
+ },
+ "node_modules/prelude-ls": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz",
+ "integrity": "sha512-ESF23V4SKG6lVSGZgYNpbsiaAkdab6ZgOxe52p7+Kid3W3u3bxR4Vfd/o21dmN7jSt0IwgZ4v5MUd26FEtXE9w==",
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/proxy-from-env": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz",
+ "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg=="
+ },
+ "node_modules/queue-microtask": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+ "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/redeyed": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/redeyed/-/redeyed-2.1.1.tgz",
+ "integrity": "sha512-FNpGGo1DycYAdnrKFxCMmKYgo/mILAqtRYbkdQD8Ep/Hk2PQ5+aEAEx+IU713RTDmuBaH0c8P5ZozurNu5ObRQ==",
+ "dependencies": {
+ "esprima": "~4.0.0"
+ }
+ },
+ "node_modules/redeyed/node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/reusify": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz",
+ "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==",
+ "engines": {
+ "iojs": ">=1.0.0",
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/run-parallel": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
+ "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "dependencies": {
+ "queue-microtask": "^1.2.2"
+ }
+ },
+ "node_modules/semver": {
+ "version": "7.6.3",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz",
+ "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==",
+ "bin": {
+ "semver": "bin/semver.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/shebang-command": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
+ "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
+ "dependencies": {
+ "shebang-regex": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/shebang-regex": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
+ "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/sisteransi": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg=="
+ },
+ "node_modules/slash": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
+ "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/slice-ansi": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz",
+ "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "astral-regex": "^2.0.0",
+ "is-fullwidth-code-point": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/slice-ansi?sponsor=1"
+ }
+ },
+ "node_modules/source-map": {
+ "version": "0.6.1",
+ "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+ "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
+ "optional": true,
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/sprintf-js": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
+ "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g=="
+ },
+ "node_modules/static-eval": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/static-eval/-/static-eval-2.0.2.tgz",
+ "integrity": "sha512-N/D219Hcr2bPjLxPiV+TQE++Tsmrady7TqAJugLy7Xk1EumfDWS/f5dtBbkRCGE7wKKXuYockQoj8Rm2/pVKyg==",
+ "dependencies": {
+ "escodegen": "^1.8.1"
+ }
+ },
+ "node_modules/string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "dependencies": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "dependencies": {
+ "ansi-regex": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/supports-color": {
+ "version": "8.1.1",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz",
+ "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/supports-color?sponsor=1"
+ }
+ },
+ "node_modules/supports-hyperlinks": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/supports-hyperlinks/-/supports-hyperlinks-2.3.0.tgz",
+ "integrity": "sha512-RpsAZlpWcDwOPQA22aCH4J0t7L8JmAvsCxfOSEwm7cQs3LshN36QaTkwd70DnBOXDWGssw2eUoc8CaRWT0XunA==",
+ "dependencies": {
+ "has-flag": "^4.0.0",
+ "supports-color": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/supports-hyperlinks/node_modules/supports-color": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+ "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "dependencies": {
+ "is-number": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0"
+ }
+ },
+ "node_modules/ts-node": {
+ "version": "10.9.2",
+ "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
+ "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==",
+ "dependencies": {
+ "@cspotcode/source-map-support": "^0.8.0",
+ "@tsconfig/node10": "^1.0.7",
+ "@tsconfig/node12": "^1.0.7",
+ "@tsconfig/node14": "^1.0.0",
+ "@tsconfig/node16": "^1.0.2",
+ "acorn": "^8.4.1",
+ "acorn-walk": "^8.1.1",
+ "arg": "^4.1.0",
+ "create-require": "^1.1.0",
+ "diff": "^4.0.1",
+ "make-error": "^1.1.1",
+ "v8-compile-cache-lib": "^3.0.1",
+ "yn": "3.1.1"
+ },
+ "bin": {
+ "ts-node": "dist/bin.js",
+ "ts-node-cwd": "dist/bin-cwd.js",
+ "ts-node-esm": "dist/bin-esm.js",
+ "ts-node-script": "dist/bin-script.js",
+ "ts-node-transpile-only": "dist/bin-transpile.js",
+ "ts-script": "dist/bin-script-deprecated.js"
+ },
+ "peerDependencies": {
+ "@swc/core": ">=1.2.50",
+ "@swc/wasm": ">=1.2.50",
+ "@types/node": "*",
+ "typescript": ">=2.7"
+ },
+ "peerDependenciesMeta": {
+ "@swc/core": {
+ "optional": true
+ },
+ "@swc/wasm": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/tslib": {
+ "version": "2.8.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.0.tgz",
+ "integrity": "sha512-jWVzBLplnCmoaTr13V9dYbiQ99wvZRd0vNWaDRg+aVYRcjDF3nDksxFDE/+fkXnKhpnUUkmx5pK/v8mCtLVqZA=="
+ },
+ "node_modules/type-check": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz",
+ "integrity": "sha512-ZCmOJdvOWDBYJlzAoFkC+Q0+bUyEOS1ltgp1MGU03fqHG+dbi9tBFU2Rd9QKiDZFAYrhPh2JUf7rZRIuHRKtOg==",
+ "dependencies": {
+ "prelude-ls": "~1.1.2"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/type-fest": {
+ "version": "0.21.3",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz",
+ "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/typescript": {
+ "version": "5.6.3",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz",
+ "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==",
+ "peer": true,
+ "bin": {
+ "tsc": "bin/tsc",
+ "tsserver": "bin/tsserver"
+ },
+ "engines": {
+ "node": ">=14.17"
+ }
+ },
+ "node_modules/underscore": {
+ "version": "1.12.1",
+ "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz",
+ "integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw=="
+ },
+ "node_modules/undici-types": {
+ "version": "6.19.8",
+ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz",
+ "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw=="
+ },
+ "node_modules/universalify": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz",
+ "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==",
+ "engines": {
+ "node": ">= 10.0.0"
+ }
+ },
+ "node_modules/utility-types": {
+ "version": "3.11.0",
+ "resolved": "https://registry.npmjs.org/utility-types/-/utility-types-3.11.0.tgz",
+ "integrity": "sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw==",
+ "engines": {
+ "node": ">= 4"
+ }
+ },
+ "node_modules/v8-compile-cache-lib": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz",
+ "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg=="
+ },
+ "node_modules/which": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+ "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+ "dependencies": {
+ "isexe": "^2.0.0"
+ },
+ "bin": {
+ "node-which": "bin/node-which"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/widest-line": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz",
+ "integrity": "sha512-NsmoXalsWVDMGupxZ5R08ka9flZjjiLvHVAWYOKtiKM8ujtZWr9cRffak+uSE48+Ob8ObalXpwyeUiyDD6QFgg==",
+ "dependencies": {
+ "string-width": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/word-wrap": {
+ "version": "1.2.5",
+ "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz",
+ "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/wordwrap": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
+ "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q=="
+ },
+ "node_modules/wrap-ansi": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+ "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+ }
+ },
+ "node_modules/yn": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz",
+ "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==",
+ "engines": {
+ "node": ">=6"
+ }
+ }
+ }
+}
diff --git a/.buildkite/scripts/steps/openapi_publishing/package.json b/.buildkite/scripts/steps/openapi_publishing/package.json
new file mode 100644
index 0000000000000..fa60b97905b14
--- /dev/null
+++ b/.buildkite/scripts/steps/openapi_publishing/package.json
@@ -0,0 +1,15 @@
+{
+ "name": "serverless",
+ "version": "1.0.0",
+ "main": "index.js",
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "ISC",
+ "description": "",
+ "dependencies": {
+ "bump-cli": "^2.8.4"
+ }
+}
diff --git a/.buildkite/scripts/steps/openapi_publishing/publish_oas_docs.sh b/.buildkite/scripts/steps/openapi_publishing/publish_oas_docs.sh
new file mode 100755
index 0000000000000..2791f9519afd9
--- /dev/null
+++ b/.buildkite/scripts/steps/openapi_publishing/publish_oas_docs.sh
@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+source .buildkite/scripts/common/util.sh
+
+echo "--- Publish OAS docs"
+
+echo "--- Installing NPM modules"
+
+deploy_to_bump() {
+ local file_path="${1:-}"
+ local doc_name="${2:-}"
+ local doc_token="${3:-}"
+ local branch="${4:-}"
+ local cur_dir=$(pwd)
+
+ cd "$(dirname "${BASH_SOURCE[0]}")"
+ npm install
+
+ echo "Checking diff for doc '$doc_name' against file '$file_path' on branch '$branch'..."
+ local result=$(npx bump diff $file_path --doc $doc_name --token $doc_token --branch $branch --format=json)
+ local change_count=$(jq '. | length' <<<$result)
+ if [[ ! -z $change_count && $change_count -gt 0 ]]; then
+ echo "Found $change_count changes..."
+ echo "About to deploy file '$file_path' to doc '$doc_name' to '$branch' on bump.sh..."
+ npx bump deploy $file_path \
+ --branch $branch \
+ --doc $doc_name \
+ --token $doc_token ;
+ echo ""
+ echo "Note: if there is a warning of unchanged docs we probably have unpublished deployments waiting."
+ echo "Go to https://bump.sh/elastic/dashboard to see all the docs in the hub."
+ else
+ echo "Did not detect changes for '$file_path'; not deploying. Got response: '$result'"
+ fi
+
+ echo "Switch back to dir '$cur_dir'"
+ cd $cur_dir
+}
+
+if [[ "$BUILDKITE_BRANCH" == "main" ]]; then
+ BUMP_KIBANA_DOC_NAME="$(vault_get kibana-bump-sh kibana-doc-name)"
+ BUMP_KIBANA_DOC_TOKEN="$(vault_get kibana-bump-sh kibana-token)"
+ deploy_to_bump "$(pwd)/oas_docs/output/kibana.yaml" $BUMP_KIBANA_DOC_NAME $BUMP_KIBANA_DOC_TOKEN main;
+ exit 0;
+fi
+
+if [[ "$BUILDKITE_BRANCH" == "8.x" ]]; then
+ BUMP_KIBANA_DOC_NAME="$(vault_get kibana-bump-sh kibana-doc-name)"
+ BUMP_KIBANA_DOC_TOKEN="$(vault_get kibana-bump-sh kibana-token)"
+ deploy_to_bump "$(pwd)/oas_docs/output/kibana.yaml" $BUMP_KIBANA_DOC_NAME $BUMP_KIBANA_DOC_TOKEN 8x-unreleased;
+ exit 0;
+fi
+
+echo "No branches found to push to; stopping here."
\ No newline at end of file
diff --git a/.buildkite/scripts/steps/test/jest_parallel.sh b/.buildkite/scripts/steps/test/jest_parallel.sh
index 2a7cf780f5787..648c3b225141d 100755
--- a/.buildkite/scripts/steps/test/jest_parallel.sh
+++ b/.buildkite/scripts/steps/test/jest_parallel.sh
@@ -60,7 +60,14 @@ while read -r config; do
# --trace-warnings to debug
# Node.js process-warning detected:
# Warning: Closing file descriptor 24 on garbage collection
- cmd="NODE_OPTIONS=\"--max-old-space-size=12288 --trace-warnings\" node ./scripts/jest --config=\"$config\" $parallelism --coverage=false --passWithNoTests"
+ cmd="NODE_OPTIONS=\"--max-old-space-size=12288 --trace-warnings"
+
+ if [ "${KBN_ENABLE_FIPS:-}" == "true" ]; then
+ cmd=$cmd" --enable-fips --openssl-config=$HOME/nodejs.cnf"
+ fi
+
+ cmd=$cmd"\" node ./scripts/jest --config=\"$config\" $parallelism --coverage=false --passWithNoTests"
+
echo "actual full command is:"
echo "$cmd"
echo ""
diff --git a/.devcontainer/scripts/env.sh b/.devcontainer/scripts/env.sh
index 77c2000663e5f..dccc17130c99c 100755
--- a/.devcontainer/scripts/env.sh
+++ b/.devcontainer/scripts/env.sh
@@ -9,7 +9,7 @@ setup_fips() {
fi
if [ -n "$FIPS" ] && [ "$FIPS" = "1" ]; then
- sed -i '/xpack.security.experimental.fipsMode.enabled:/ {s/.*/xpack.security.experimental.fipsMode.enabled: true/; t}; $a\xpack.security.experimental.fipsMode.enabled: true' "$KBN_CONFIG_FILE"
+ sed -i '/xpack.security.fipsMode.enabled:/ {s/.*/xpack.security.fipsMode.enabled: true/; t}; $a\xpack.security.fipsMode.enabled: true' "$KBN_CONFIG_FILE"
# Patch node_modules so we can start Kibana in dev mode
sed -i 's/hashType = hashType || '\''md5'\'';/hashType = hashType || '\''sha1'\'';/g' "${KBN_DIR}/node_modules/file-loader/node_modules/loader-utils/lib/getHashDigest.js"
@@ -21,7 +21,7 @@ setup_fips() {
echo "FIPS mode enabled"
echo "If manually bootstrapping in FIPS mode use: NODE_OPTIONS='' yarn kbn bootstrap"
else
- sed -i '/xpack.security.experimental.fipsMode.enabled:/ {s/.*/xpack.security.experimental.fipsMode.enabled: false/; t}; $a\xpack.security.experimental.fipsMode.enabled: false' "$KBN_CONFIG_FILE"
+ sed -i '/xpack.security.fipsMode.enabled:/ {s/.*/xpack.security.fipsMode.enabled: false/; t}; $a\xpack.security.fipsMode.enabled: false' "$KBN_CONFIG_FILE"
fi
}
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 1b9c828de461c..6898e69a44eeb 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -47,6 +47,7 @@ packages/cloud @elastic/kibana-core
packages/content-management/content_editor @elastic/appex-sharedux
packages/content-management/content_insights/content_insights_public @elastic/appex-sharedux
packages/content-management/content_insights/content_insights_server @elastic/appex-sharedux
+packages/content-management/favorites/favorites_common @elastic/appex-sharedux
packages/content-management/favorites/favorites_public @elastic/appex-sharedux
packages/content-management/favorites/favorites_server @elastic/appex-sharedux
packages/content-management/tabbed_table_list_view @elastic/appex-sharedux
@@ -193,6 +194,7 @@ packages/core/plugins/core-plugins-server-mocks @elastic/kibana-core
packages/core/preboot/core-preboot-server @elastic/kibana-core
packages/core/preboot/core-preboot-server-internal @elastic/kibana-core
packages/core/preboot/core-preboot-server-mocks @elastic/kibana-core
+packages/core/rendering/core-rendering-browser @elastic/kibana-core
packages/core/rendering/core-rendering-browser-internal @elastic/kibana-core
packages/core/rendering/core-rendering-browser-mocks @elastic/kibana-core
packages/core/rendering/core-rendering-server-internal @elastic/kibana-core
@@ -225,7 +227,6 @@ packages/core/security/core-security-server @elastic/kibana-core
packages/core/security/core-security-server-internal @elastic/kibana-core
packages/core/security/core-security-server-mocks @elastic/kibana-core
packages/core/status/core-status-common @elastic/kibana-core
-packages/core/status/core-status-common-internal @elastic/kibana-core
packages/core/status/core-status-server @elastic/kibana-core
packages/core/status/core-status-server-internal @elastic/kibana-core
packages/core/status/core-status-server-mocks @elastic/kibana-core
@@ -658,7 +659,7 @@ src/plugins/files @elastic/appex-sharedux
src/plugins/files_management @elastic/appex-sharedux
src/plugins/ftr_apis @elastic/kibana-core
src/plugins/guided_onboarding @elastic/appex-sharedux
-src/plugins/home @elastic/kibana-core
+src/plugins/home @elastic/appex-sharedux
src/plugins/image_embeddable @elastic/appex-sharedux
src/plugins/input_control_vis @elastic/kibana-presentation
src/plugins/inspector @elastic/kibana-presentation
@@ -767,6 +768,7 @@ x-pack/examples/triggers_actions_ui_example @elastic/response-ops
x-pack/examples/ui_actions_enhanced_examples @elastic/appex-sharedux
x-pack/packages/ai-infra/inference-common @elastic/appex-ai-infra
x-pack/packages/ai-infra/product-doc-artifact-builder @elastic/appex-ai-infra
+x-pack/packages/ai-infra/product-doc-common @elastic/appex-ai-infra
x-pack/packages/index-lifecycle-management/index_lifecycle_management_common_shared @elastic/kibana-management
x-pack/packages/index-management/index_management_shared_types @elastic/kibana-management
x-pack/packages/kbn-ai-assistant @elastic/search-kibana
@@ -831,7 +833,9 @@ x-pack/packages/observability/alerting_rule_utils @elastic/obs-ux-management-tea
x-pack/packages/observability/alerting_test_data @elastic/obs-ux-management-team
x-pack/packages/observability/get_padded_alert_time_range_util @elastic/obs-ux-management-team
x-pack/packages/observability/logs_overview @elastic/obs-ux-logs-team
-x-pack/packages/observability/observability_utils @elastic/observability-ui
+x-pack/packages/observability/observability_utils/observability_utils_browser @elastic/observability-ui
+x-pack/packages/observability/observability_utils/observability_utils_common @elastic/observability-ui
+x-pack/packages/observability/observability_utils/observability_utils_server @elastic/observability-ui
x-pack/packages/observability/synthetics_test_data @elastic/obs-ux-management-team
x-pack/packages/rollup @elastic/kibana-management
x-pack/packages/search/shared_ui @elastic/search-kibana
@@ -854,6 +858,8 @@ x-pack/packages/security/role_management_model @elastic/kibana-security
x-pack/packages/security/ui_components @elastic/kibana-security
x-pack/performance @elastic/appex-qa
x-pack/plugins/actions @elastic/response-ops
+x-pack/plugins/ai_infra/llm_tasks @elastic/appex-ai-infra
+x-pack/plugins/ai_infra/product_doc_base @elastic/appex-ai-infra
x-pack/plugins/aiops @elastic/ml-ui
x-pack/plugins/alerting @elastic/response-ops
x-pack/plugins/banners @elastic/appex-sharedux
@@ -1036,9 +1042,21 @@ x-pack/test_serverless/api_integration/test_suites/common/platform_security @ela
/x-pack/plugins/entity_manager @elastic/obs-entities
/x-pack/test/api_integration/apis/entity_manager @elastic/obs-entities
+
# Data Discovery
-/test/plugin_functional/plugins/data_search @elastic/kibana-data-discovery
+/test/functional/fixtures/es_archiver/alias @elastic/kibana-data-discovery
+/test/functional/page_objects/context_page.ts @elastic/kibana-data-discovery
+/test/functional/services/data_views.ts @elastic/kibana-data-discovery
+/test/functional/services/saved_objects_finder.ts @elastic/kibana-data-discovery
/test/plugin_functional/plugins/index_patterns @elastic/kibana-data-discovery
+/test/plugin_functional/plugins/data_search @elastic/kibana-data-discovery
+/test/functional/page_objects/discover_page.ts @elastic/kibana-data-discovery
+/test/functional/fixtures/es_archiver/index_pattern_without_timefield @elastic/kibana-data-discovery
+/test/functional/fixtures/es_archiver/huge_fields @elastic/kibana-data-discovery
+/test/functional/fixtures/es_archiver/date_n* @elastic/kibana-data-discovery
+/test/functional/firefox/discover.config.ts @elastic/kibana-data-discovery
+/test/functional/fixtures/es_archiver/discover @elastic/kibana-data-discovery
+/test/api_integration/apis/saved_queries @elastic/kibana-data-discovery
/x-pack/test/api_integration/apis/kibana/kql_telemetry @elastic/kibana-data-discovery @elastic/kibana-visualizations
/x-pack/test_serverless/functional/es_archives/pre_calculated_histogram @elastic/kibana-data-discovery
/x-pack/test_serverless/functional/es_archives/kibana_sample_data_flights_index_pattern @elastic/kibana-data-discovery
@@ -1098,6 +1116,32 @@ src/plugins/discover/public/context_awareness/profile_providers/security @elasti
/x-pack/test/screenshot_creation @elastic/platform-docs
# Visualizations
+/test/functional/apps/getting_started/*.ts @elastic/kibana-visualizations # Assigned per https://github.com/elastic/kibana/pull/199767#discussion_r1840485031
+/x-pack/test/upgrade/apps/graph @elastic/kibana-visualizations
+/x-pack/test/functional/page_objects/log_wrapper.ts @elastic/kibana-visualizations # Assigned per https://github.com/elastic/kibana/pull/36437
+/x-pack/test/functional/page_objects/graph_page.ts @elastic/kibana-visualizations
+/x-pack/test/functional/apps/managed_content @elastic/kibana-visualizations
+/test/functional/services/visualizations @elastic/kibana-visualizations
+/test/functional/services/renderable.ts @elastic/kibana-visualizations
+/test/functional/page_objects/vega_chart_page.ts @elastic/kibana-visualizations
+/test/functional/page_objects/visual_builder_page.ts @elastic/kibana-visualizations
+/test/functional/page_objects/visualize_*.ts @elastic/kibana-visualizations
+/test/functional/page_objects/timelion_page.ts @elastic/kibana-visualizations
+/test/functional/page_objects/time_to_visualize_page.ts @elastic/kibana-visualizations
+/test/functional/page_objects/tag_cloud_page.ts @elastic/kibana-visualizations
+/x-pack/test/functional/page_objects/lens_page.ts @elastic/kibana-visualizations
+/x-pack/test/functional/es_archives/lens @elastic/kibana-visualizations
+/x-pack/test/examples/embedded_lens @elastic/kibana-visualizations
+/x-pack/test/api_integration/fixtures/kbn_archiver/lens/constant_keyword.json @elastic/kibana-visualizations
+/test/plugin_functional/test_suites/custom_visualizations @elastic/kibana-visualizations
+/test/plugin_functional/plugins/kbn_tp_custom_visualizations @elastic/kibana-visualizations
+/x-pack/test/functional/fixtures/kbn_archiver/visualize @elastic/kibana-visualizations
+/x-pack/test/functional/fixtures/kbn_archiver/lens @elastic/kibana-visualizations
+/test/functional/page_objects/legacy/data_table_vis.ts @elastic/kibana-visualizations
+/test/functional/page_objects/annotation_library_editor_page.ts @elastic/kibana-visualizations # Assigned per git blame
+/test/functional/firefox/visualize.config.ts @elastic/kibana-visualizations
+/test/examples/expressions_explorer/*.ts @elastic/kibana-visualizations
+/test/accessibility/apps/visualize.ts @elastic/kibana-visualizations
/x-pack/test/accessibility/apps/group3/graph.ts @elastic/kibana-visualizations
/x-pack/test/accessibility/apps/group2/lens.ts @elastic/kibana-visualizations
/x-pack/test/functional/apps/visualize @elastic/kibana-visualizations
@@ -1111,6 +1155,10 @@ src/plugins/discover/public/context_awareness/profile_providers/security @elasti
/x-pack/test_serverless/functional/fixtures/kbn_archiver/lens/ @elastic/kibana-visualizations
packages/kbn-monaco/src/esql @elastic/kibana-esql
+# ESQL
+/test/api_integration/apis/esql/*.ts @elastic/kibana-esql
+/test/functional/services/esql.ts @elastic/kibana-esql
+
# Global Experience
### Global Experience Reporting
@@ -1170,6 +1218,10 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
## This should allow the infra team to work without dependencies on the @elastic/obs-ux-logs-team, which will maintain ownership of the Logs UI code only.
## infra/{common,docs,public,server}/{sub-folders}/ -> @elastic/obs-ux-infra_services-team
+# obs-ux-infra_services-team
+/x-pack/test/functional/page_objects/asset_details.ts @elastic/obs-ux-infra_services-team # Assigned per https://github.com/elastic/kibana/pull/200157/files/c83fae62151fe634342c498aca69b686b739fe45#r1842202022
+/x-pack/test/functional/page_objects/infra_* @elastic/obs-ux-infra_services-team
+/x-pack/test/functional/es_archives/infra @elastic/obs-ux-infra_services-team
/test/common/plugins/otel_metrics @elastic/obs-ux-infra_services-team
/x-pack/plugins/observability_solution/infra/common @elastic/obs-ux-infra_services-team
/x-pack/plugins/observability_solution/infra/docs @elastic/obs-ux-infra_services-team
@@ -1191,10 +1243,10 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/plugins/observability_solution/infra/server/services @elastic/obs-ux-infra_services-team
/x-pack/plugins/observability_solution/infra/server/usage @elastic/obs-ux-infra_services-team
/x-pack/plugins/observability_solution/infra/server/utils @elastic/obs-ux-infra_services-team
-/x-pack/test/api_integration/deployment_agnostic/apis/observability/infra @elastic/obs-ux-logs-team
-/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm @elastic/obs-ux-logs-team
+/x-pack/test/api_integration/services/infraops_source_configuration.ts @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team # Assigned per https://github.com/elastic/kibana/pull/34916
## Logs UI code exceptions -> @elastic/obs-ux-logs-team
+/x-pack/test/upgrade/apps/logs @elastic/obs-ux-logs-team
/x-pack/test_serverless/functional/page_objects/svl_oblt_onboarding_stream_log_file.ts @elastic/obs-ux-logs-team
/x-pack/test_serverless/functional/page_objects/svl_oblt_onboarding_page.ts @elastic/obs-ux-logs-team
/x-pack/plugins/observability_solution/infra/common/http_api/log_alerts @elastic/obs-ux-logs-team
@@ -1216,12 +1268,20 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/plugins/observability_solution/infra/server/routes/log_alerts @elastic/obs-ux-logs-team
/x-pack/plugins/observability_solution/infra/server/routes/log_analysis @elastic/obs-ux-logs-team
/x-pack/plugins/observability_solution/infra/server/services/rules @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team
+/x-pack/test/common/utils/synthtrace @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team # Assigned per https://github.com/elastic/kibana/blob/main/packages/kbn-apm-synthtrace/kibana.jsonc#L5
+
# Infra Monitoring tests
/x-pack/test/api_integration/apis/infra @elastic/obs-ux-infra_services-team
/x-pack/test/functional/apps/infra @elastic/obs-ux-infra_services-team
/x-pack/test/functional/apps/infra/logs @elastic/obs-ux-logs-team
# Observability UX management team
+/x-pack/test/api_integration/services/data_view_api.ts @elastic/obs-ux-management-team
+/x-pack/test/api_integration/services/slo.ts @elastic/obs-ux-management-team
+/x-pack/test/functional/services/slo @elastic/obs-ux-management-team
+/x-pack/test/functional/apps/slo @elastic/obs-ux-management-team
+/x-pack/test/observability_api_integration @elastic/obs-ux-management-team # Assigned per https://github.com/elastic/kibana/pull/182243
+/x-pack/test/functional/services/observability @elastic/obs-ux-management-team
/x-pack/test/api_integration/apis/slos @elastic/obs-ux-management-team
/x-pack/test/accessibility/apps/group1/uptime.ts @elastic/obs-ux-management-team
/x-pack/test/accessibility/apps/group3/observability.ts @elastic/obs-ux-management-team
@@ -1232,12 +1292,15 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/test_serverless/**/test_suites/observability/custom_threshold_rule/ @elastic/obs-ux-management-team
/x-pack/test_serverless/**/test_suites/observability/slos/ @elastic/obs-ux-management-team
/x-pack/test_serverless/api_integration/test_suites/observability/es_query_rule @elastic/obs-ux-management-team
-/x-pack/test/api_integration/deployment_agnostic/apis/observability/alerting @elastic/obs-ux-management-team
+/x-pack/test/api_integration/deployment_agnostic/apis/observability/alerting/burn_rate_rule @elastic/obs-ux-management-team
/x-pack/test/api_integration/deployment_agnostic/services/alerting_api @elastic/obs-ux-management-team
/x-pack/test/api_integration/deployment_agnostic/services/slo_api @elastic/obs-ux-management-team
/x-pack/test_serverless/**/test_suites/observability/infra/ @elastic/obs-ux-infra_services-team
# Elastic Stack Monitoring
+/x-pack/test/monitoring_api_integration @elastic/stack-monitoring
+/x-pack/test/functional/page_objects/monitoring_page.ts @elastic/stack-monitoring
+/x-pack/test/functional/es_archives/monitoring @elastic/stack-monitoring
/x-pack/test/functional/services/monitoring @elastic/stack-monitoring
/x-pack/test/functional/apps/monitoring @elastic/stack-monitoring
/x-pack/test/api_integration/apis/monitoring @elastic/stack-monitoring
@@ -1246,9 +1309,10 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/test/accessibility/apps/group3/stack_monitoring.ts @elastic/stack-monitoring
# Fleet
-/x-pack/test_serverless/api_integration/test_suites/security/fleet @elastic/fleet
-/x-pack/test/fleet_packages @elastic/fleet
+/x-pack/test/api_integration/services/fleet_and_agents.ts @elastic/fleet
/x-pack/test/fleet_api_integration @elastic/fleet
+/x-pack/test/fleet_packages @elastic/fleet
+/test/api_integration/apis/custom_integration/*.ts @elastic/fleet
/x-pack/test/fleet_cypress @elastic/fleet
/x-pack/test/fleet_functional @elastic/fleet
/src/dev/build/tasks/bundle_fleet_packages.ts @elastic/fleet @elastic/kibana-operations
@@ -1256,7 +1320,10 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/test_serverless/**/test_suites/**/fleet/ @elastic/fleet
# APM
-/x-pack/test/functional/apps/apm/ @elastic/obs-ux-infra_services-team
+/x-pack/test/stack_functional_integration/apps/apm @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team
+/x-pack/test/common/services/apm_synthtrace_kibana_client.ts @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team
+/test/api_integration/apis/ui_metric/*.ts @elastic/obs-ux-infra_services-team
+/x-pack/test/functional/apps/apm/ @elastic/obs-ux-infra_services-team
/x-pack/test/apm_api_integration/ @elastic/obs-ux-infra_services-team
/src/apm.js @elastic/kibana-core @vigneshshanmugam
/packages/kbn-utility-types/src/dot.ts @dgieselaar
@@ -1266,6 +1333,7 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
#CC# /x-pack/plugins/observability_solution/observability/ @elastic/apm-ui
# Uptime
+/x-pack/test/functional/page_objects/uptime_page.ts @elastic/obs-ux-management-team
/x-pack/test/functional_with_es_ssl/apps/discover_ml_uptime/uptime/ @elastic/obs-ux-management-team
/x-pack/test/functional/apps/uptime @elastic/obs-ux-management-team
/x-pack/test/functional/es_archives/uptime @elastic/obs-ux-management-team
@@ -1277,6 +1345,16 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/test_serverless/api_integration/test_suites/observability/synthetics @elastic/obs-ux-management-team
# obs-ux-logs-team
+/x-pack/test_serverless/functional/test_suites/observability/config.* @elastic/obs-ux-logs-team
+/x-pack/test_serverless/functional/test_suites/observability/landing_page.ts @elastic/obs-ux-logs-team
+/x-pack/test_serverless/functional/test_suites/observability/navigation.ts @elastic/obs-ux-logs-team
+/x-pack/test/functional/page_objects/dataset_quality.ts @elastic/obs-ux-logs-team
+/x-pack/test_serverless/functional/test_suites/observability/index* @elastic/obs-ux-logs-team
+/x-pack/test_serverless/functional/test_suites/observability/cypress @elastic/obs-ux-logs-team
+/x-pack/test/functional/services/infra_source_configuration_form.ts @elastic/obs-ux-logs-team
+/x-pack/test/functional/services/logs_ui @elastic/obs-ux-logs-team
+/x-pack/test/functional/page_objects/observability_logs_explorer.ts @elastic/obs-ux-logs-team
+/test/functional/services/selectable.ts @elastic/obs-ux-logs-team
/x-pack/test/observability_onboarding_api_integration @elastic/obs-ux-logs-team
/x-pack/test_serverless/api_integration/test_suites/observability/index.feature_flags.ts @elastic/obs-ux-logs-team
/x-pack/test/api_integration/apis/logs_ui @elastic/obs-ux-logs-team
@@ -1286,10 +1364,16 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer @elastic/obs-ux-logs-team
/x-pack/test/functional/apps/dataset_quality @elastic/obs-ux-logs-team
/x-pack/test_serverless/functional/test_suites/observability/dataset_quality @elastic/obs-ux-logs-team
-/x-pack/test_serverless/functional/test_suites/observability/ @elastic/obs-ux-logs-team
+/x-pack/test_serverless/functional/test_suites/observability/discover @elastic/obs-ux-logs-team @elastic/kibana-data-discovery
/src/plugins/unified_doc_viewer/public/components/doc_viewer_logs_overview @elastic/obs-ux-logs-team
/x-pack/test/api_integration/apis/logs_shared @elastic/obs-ux-logs-team
+# Observability-ui
+/x-pack/test_serverless/api_integration/test_suites/observability/index.ts @elastic/observability-ui
+/x-pack/test/functional_solution_sidenav/tests/observability_sidenav.ts @elastic/observability-ui
+/x-pack/test/functional/page_objects/observability_page.ts @elastic/observability-ui
+/x-pack/test_serverless/**/test_suites/observability/config.ts @elastic/observability-ui
+
# Observability onboarding tour
/x-pack/plugins/observability_solution/observability_shared/public/components/tour @elastic/appex-sharedux
/x-pack/test/functional/apps/infra/tour.ts @elastic/appex-sharedux
@@ -1300,7 +1384,23 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
### END Observability Plugins
# Presentation
-/x-pack/test/disable_ems @elastic/kibana-presentation
+/test/interpreter_functional/snapshots @elastic/kibana-presentation # Assigned per https://github.com/elastic/kibana/pull/54342
+/test/functional/services/inspector.ts @elastic/kibana-presentation
+/x-pack/test/functional/services/canvas_element.ts @elastic/kibana-presentation
+/x-pack/test/functional/page_objects/canvas_page.ts @elastic/kibana-presentation
+/x-pack/test/accessibility/apps/group3/canvas.ts @elastic/kibana-presentation
+/x-pack/test/upgrade/apps/canvas @elastic/kibana-presentation
+/x-pack/test/upgrade/apps/dashboard @elastic/kibana-presentation
+/test/functional/screenshots/baseline/tsvb_dashboard.png @elastic/kibana-presentation
+/test/functional/screenshots/baseline/dashboard_*.png @elastic/kibana-presentation
+/test/functional/screenshots/baseline/area_chart.png @elastic/kibana-presentation
+/x-pack/test/disable_ems @elastic/kibana-presentation # Assigned per https://github.com/elastic/kibana/pull/165986
+/x-pack/test/functional/fixtures/kbn_archiver/dashboard* @elastic/kibana-presentation
+/test/functional/page_objects/dashboard_page* @elastic/kibana-presentation
+/test/functional/firefox/dashboard.config.ts @elastic/kibana-presentation # Assigned per: https://github.com/elastic/kibana/issues/15023
+/test/functional/fixtures/es_archiver/dashboard @elastic/kibana-presentation # Assigned per: https://github.com/elastic/kibana/issues/15023
+/test/accessibility/apps/dashboard.ts @elastic/kibana-presentation
+/test/accessibility/apps/filter_panel.ts @elastic/kibana-presentation
/x-pack/test/functional/apps/dashboard @elastic/kibana-presentation
/x-pack/test/accessibility/apps/group3/maps.ts @elastic/kibana-presentation
/x-pack/test/accessibility/apps/group1/dashboard_panel_options.ts @elastic/kibana-presentation
@@ -1314,10 +1414,24 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/test/plugin_functional/test_suites/panel_actions @elastic/kibana-presentation
/x-pack/test/functional/es_archives/canvas/logstash_lens @elastic/kibana-presentation
#CC# /src/plugins/kibana_react/public/code_editor/ @elastic/kibana-presentation
+/x-pack/test/upgrade/services/maps_upgrade_services.ts @elastic/kibana-presentation
+/x-pack/test/stack_functional_integration/apps/maps @elastic/kibana-presentation
+/x-pack/test/functional/page_objects/geo_file_upload.ts @elastic/kibana-presentation
+/x-pack/test/functional/page_objects/gis_page.ts @elastic/kibana-presentation
+/x-pack/test/upgrade/apps/maps @elastic/kibana-presentation
+/x-pack/test/api_integration/apis/maps/ @elastic/kibana-presentation
+/x-pack/test/functional/apps/maps/ @elastic/kibana-presentation
+/x-pack/test/functional/es_archives/maps/ @elastic/kibana-presentation
+/x-pack/plugins/stack_alerts/server/rule_types/geo_containment @elastic/kibana-presentation
+/x-pack/plugins/stack_alerts/public/rule_types/geo_containment @elastic/kibana-presentation
+
# Machine Learning
+/x-pack/test/stack_functional_integration/apps/ml @elastic/ml-ui
+/x-pack/test/functional/fixtures/kbn_archiver/ml @elastic/ml-ui
/x-pack/test/api_integration/apis/file_upload @elastic/ml-ui
/x-pack/test/accessibility/apps/group2/ml.ts @elastic/ml-ui
+/x-pack/test/accessibility/apps/group2/ml_* @elastic/ml-ui
/x-pack/test/accessibility/apps/group3/ml_embeddables_in_dashboard.ts @elastic/ml-ui
/x-pack/test/api_integration/apis/ml/ @elastic/ml-ui
/x-pack/test/api_integration_basic/apis/ml/ @elastic/ml-ui
@@ -1325,6 +1439,7 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/test/functional/es_archives/ml/ @elastic/ml-ui
/x-pack/test/functional/services/ml/ @elastic/ml-ui
/x-pack/test/functional_basic/apps/ml/ @elastic/ml-ui
+/x-pack/test/functional_with_es_ssl/apps/discover_ml_uptime/config.ts @elastic/ml-ui
/x-pack/test/functional_with_es_ssl/apps/discover_ml_uptime/ml/ @elastic/ml-ui
/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/ml_rule_types/ @elastic/ml-ui
/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/transform_rule_types/ @elastic/ml-ui
@@ -1335,7 +1450,7 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/test/api_integration/services/ml.ts @elastic/ml-ui
# Additional plugins and packages maintained by the ML team.
-/test/examples/response_stream @elastic/ml-ui
+/test/examples/response_stream/*.ts @elastic/ml-ui
/x-pack/test/accessibility/apps/group2/transform.ts @elastic/ml-ui
/x-pack/test/api_integration/apis/aiops/ @elastic/ml-ui
/x-pack/test/api_integration/apis/transform/ @elastic/ml-ui
@@ -1346,18 +1461,14 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/x-pack/test/functional/apps/aiops @elastic/ml-ui
/x-pack/test/functional/apps/transform/ @elastic/ml-ui
/x-pack/test/functional/services/transform/ @elastic/ml-ui
+/x-pack/test/functional/services/aiops @elastic/ml-ui
/x-pack/test/functional_basic/apps/transform/ @elastic/ml-ui
-# Maps
-#CC# /x-pack/plugins/maps/ @elastic/kibana-gis
-/x-pack/test/api_integration/apis/maps/ @elastic/kibana-gis
-/x-pack/test/functional/apps/maps/ @elastic/kibana-gis
-/x-pack/test/functional/es_archives/maps/ @elastic/kibana-gis
-/x-pack/plugins/stack_alerts/server/rule_types/geo_containment @elastic/kibana-gis
-/x-pack/plugins/stack_alerts/public/rule_types/geo_containment @elastic/kibana-gis
-#CC# /x-pack/plugins/file_upload @elastic/kibana-gis
-
# Operations
+/test/package @elastic/kibana-operations
+/test/package/roles @elastic/kibana-operations
+/test/common/fixtures/plugins/coverage/kibana.json @elastic/kibana-operations
+/x-pack/test/plugin_functional/screenshots @elastic/kibana-operations # Assigned per https://github.com/elastic/kibana/pull/94370/files
/src/dev/license_checker/config.ts @elastic/kibana-operations
/src/dev/ @elastic/kibana-operations
/src/setup_node_env/ @elastic/kibana-operations
@@ -1384,7 +1495,90 @@ x-pack/test_serverless/**/test_suites/observability/ai_assistant @elastic/obs-ai
/.eslintrc.js @elastic/kibana-operations
/.eslintignore @elastic/kibana-operations
-# Appex QA
+# QA - Appex QA
+/test/server_integration/services/index.js @elastic/appex-qa
+/x-pack/test/stack_functional_integration/configs/config.stack_functional_integration_base.js @elastic/appex-qa
+/x-pack/test/stack_functional_integration/configs/consume_state.js @elastic/appex-qa
+/x-pack/test/functional/services/remote_es/remote_es_archiver.ts @elastic/appex-qa
+/test/functional/services/remote_es/remote_es_archiver.ts @elastic/appex-qa
+/x-pack/test/kibana.jsonc @elastic/appex-qa
+/x-pack/test/functional_with_es_ssl/ftr_provider_context.d.ts @elastic/appex-qa
+/x-pack/test/stack_functional_integration/apps @elastic/appex-qa
+/x-pack/test/plugin_functional/config.ts @elastic/appex-qa
+/x-pack/test/plugin_functional/ftr_provider_context.d.ts @elastic/appex-qa
+/x-pack/test/plugin_functional/page_objects.ts @elastic/appex-qa
+/x-pack/test/upgrade/services/index.ts @elastic/appex-qa
+/x-pack/test/upgrade/ftr_provider_context.d.ts @elastic/appex-qa
+/x-pack/test/upgrade/config.ts @elastic/appex-qa
+/x-pack/test/functional_basic/ftr_provider_context.d.ts @elastic/appex-qa
+/x-pack/test/functional/services/remote_es/remote_es.ts @elastic/appex-qa
+/x-pack/test/functional/services/random.js @elastic/appex-qa
+/x-pack/test/functional/services/index.ts @elastic/appex-qa
+/x-pack/test/functional/page_objects/index.ts @elastic/appex-qa
+/x-pack/test/functional/ftr_provider_context.ts @elastic/appex-qa
+/x-pack/test/functional/README.md @elastic/appex-qa
+/x-pack/test/examples/config.ts @elastic/appex-qa
+/x-pack/test/common/services/index.ts @elastic/appex-qa
+/x-pack/test/common/services/bsearch_secure.ts @elastic/appex-qa
+/x-pack/test/common/ftr_provider_context.ts @elastic/appex-qa
+/x-pack/test/api_integration_basic/ftr_provider_context.d.ts @elastic/appex-qa
+/x-pack/test/api_integration_basic/config.ts @elastic/appex-qa
+/x-pack/test/api_integration_basic/apis/index.ts @elastic/appex-qa
+/x-pack/test/api_integration/services/index.ts @elastic/appex-qa
+/x-pack/test/api_integration/services/es_supertest_without_auth.js @elastic/appex-qa
+/x-pack/test/api_integration/config.ts @elastic/appex-qa
+/x-pack/test/api_integration/apis/kibana/config.ts @elastic/appex-qa
+/x-pack/test/tsconfig.json @elastic/appex-qa
+/x-pack/test/load @elastic/appex-qa
+/test/tsconfig.json @elastic/appex-qa
+/test/plugin_functional/services/index.ts @elastic/appex-qa
+/test/plugin_functional/README.md @elastic/appex-qa
+/test/plugin_functional/config.ts @elastic/appex-qa
+/test/kibana.jsonc @elastic/appex-qa
+/test/harden @elastic/appex-qa
+/test/functional/services/supertest.ts @elastic/appex-qa
+/test/functional/services/remote_es/remote_es.ts @elastic/appex-qa
+/test/functional/services/query_bar.ts @elastic/appex-qa
+/test/functional/services/menu_toggle.ts @elastic/appex-qa
+/test/functional/services/listing_table.ts @elastic/appex-qa
+/test/common/fixtures/plugins/coverage @elastic/appex-qa
+/test/functional/services/index.ts @elastic/appex-qa
+/test/functional/services/global_nav.ts @elastic/appex-qa
+/test/functional/services/flyout.ts @elastic/appex-qa
+/test/functional/services/filter_bar.ts @elastic/appex-qa
+/test/functional/services/field_editor.ts @elastic/appex-qa
+/test/functional/services/embedding.ts @elastic/appex-qa
+/test/functional/services/doc_table.ts @elastic/appex-qa
+/test/functional/services/data_grid.ts @elastic/appex-qa
+/test/functional/services/combo_box.ts @elastic/appex-qa
+/test/functional/page_objects/unified_field_list.ts @elastic/appex-qa
+/test/functional/page_objects/time_picker.ts @elastic/appex-qa
+/test/functional/page_objects/index.ts @elastic/appex-qa
+/test/functional/page_objects/header_page.ts @elastic/appex-qa
+/test/functional/page_objects/error_page.ts @elastic/appex-qa
+/test/functional/page_objects/common_page.ts @elastic/appex-qa
+/test/functional/jest.config.js @elastic/appex-qa
+/test/functional/ftr_provider_context.ts @elastic/appex-qa
+/test/functional/fixtures/es_archiver/README.md @elastic/appex-qa
+/test/functional/firefox/config.base.ts @elastic/appex-qa
+/test/functional/config.* @elastic/appex-qa
+/test/functional/README.md @elastic/appex-qa
+/test/examples/config.js @elastic/appex-qa
+/test/examples/README.md @elastic/appex-qa
+/test/common/services/index.ts @elastic/appex-qa
+/test/common/fixtures/plugins/coverage/*.ts @elastic/appex-qa
+/test/common/config.js @elastic/appex-qa
+/test/api_integration/services/index.ts @elastic/appex-qa
+/test/api_integration/jest.config.js @elastic/appex-qa
+/test/api_integration/ftr_provider_context.d.ts @elastic/appex-qa
+/test/api_integration/config.js @elastic/appex-qa
+/test/api_integration/apis/index.ts @elastic/appex-qa
+/test/accessibility/services/index.ts @elastic/appex-qa
+/test/accessibility/services/a11y @elastic/appex-qa
+/test/accessibility/page_objects.ts @elastic/appex-qa
+/test/accessibility/ftr_provider_context.ts @elastic/appex-qa
+/test/accessibility/config.ts @elastic/appex-qa
+/test/accessibility/apps/index.ts @elastic/appex-qa
/x-pack/test/scalability @elastic/appex-qa
/src/dev/performance @elastic/appex-qa
/x-pack/test/functional/config.*.* @elastic/appex-qa
@@ -1425,10 +1619,68 @@ x-pack/test/api_integration/deployment_agnostic/services/ @elastic/appex-qa
x-pack/test/**/deployment_agnostic/ @elastic/appex-qa #temporarily to monitor tests migration
# Core
-/test/plugin_functional/plugins/rendering_plugin @elastic/kibana-core
-/test/plugin_functional/plugins/session_notifications @elastic/kibana-core
+/test/api_integration/apis/general/*.js @elastic/kibana-core # Assigned per https://github.com/elastic/kibana/pull/199795/files/894a8ede3f9d0398c5af56bf5a82654a9bc0610b#r1846691639
+/x-pack/test/plugin_api_integration/plugins/feature_usage_test @elastic/kibana-core
+/x-pack/test/functional/page_objects/navigational_search.ts @elastic/kibana-core
+/x-pack/test/stack_functional_integration/apps/savedobjects_upgrade_testing @elastic/kibana-core
+/x-pack/test/functional/page_objects/status_page.ts @elastic/kibana-core
+/x-pack/test/functional/page_objects/share_saved_objects_to_space_page.ts @elastic/kibana-core
+/x-pack/test/functional/page_objects/banners_page.ts @elastic/kibana-core
+/x-pack/test/common/lib/test_data_loader.ts @elastic/kibana-core
+/x-pack/test/api_integration/services/usage_api.ts @elastic/kibana-core
+/x-pack/test/api_integration/apis/kibana @elastic/kibana-core
+/test/api_integration/fixtures/import.ndjson @elastic/kibana-core
+/x-pack/test/plugin_api_integration @elastic/kibana-core # Assigned per https://github.com/elastic/kibana/pull/146704
+/x-pack/test/localization/ @elastic/kibana-core # Assigned per https://github.com/elastic/kibana/pull/146704
+/test/ui_capabilities/newsfeed_err @elastic/kibana-core # Assigned per https://github.com/elastic/kibana/pull/66562
+/test/server_integration/services/types.d.ts @elastic/kibana-core # Assigned per https://github.com/elastic/kibana/pull/81140
+/test/server_integration/http @elastic/kibana-core
+/test/scripts/run_multiple_kibana_nodes.sh @elastic/kibana-core
+/test/functional/services/usage_collection.ts @elastic/kibana-core
+/test/api_integration/fixtures/import_managed.ndjson @elastic/kibana-core
+/test/functional/services/apps_menu.ts @elastic/kibana-core
+/x-pack/test/functional/apps/status_page @elastic/kibana-core
+/x-pack/test/cloud_integration @elastic/kibana-core
/x-pack/test/cloud_integration/plugins/saml_provider @elastic/kibana-core
-/x-pack/test/functional_embedded/plugins/iframe_embedded @elastic/kibana-core
+/test/server_integration @elastic/kibana-core
+/x-pack/test/functional_cors @elastic/kibana-core
+/x-pack/test/stack_functional_integration/apps/telemetry @elastic/kibana-core
+/test/plugin_functional/plugins/core* @elastic/kibana-core
+/test/plugin_functional/plugins/telemetry @elastic/kibana-core
+/test/plugin_functional/plugins/session_notifications @elastic/kibana-core
+/test/plugin_functional/plugins/kbn_top_nav/ @elastic/kibana-core
+/test/plugin_functional/plugins/app_link_test @elastic/kibana-core
+/test/plugin_functional/plugins/saved_object* @elastic/kibana-core
+/test/plugin_functional/plugins/rendering_plugin @elastic/kibana-core
+/test/plugin_functional/test_suites/application_links @elastic/kibana-core
+/test/plugin_functional/test_suites/telemetry @elastic/kibana-core
+/test/plugin_functional/test_suites/usage_collection @elastic/kibana-core
+/test/plugin_functional/test_suites/saved_objects* @elastic/kibana-core
+/test/plugin_functional/test_suites/core* @elastic/kibana-core
+/test/interpreter_functional/plugins/kbn_tp_run_pipeline @elastic/kibana-core
+/x-pack/test/functional/fixtures/kbn_archiver/saved_objects_management @elastic/kibana-core
+/x-pack/test/functional_embedded @elastic/kibana-core
+/test/node_roles_functional @elastic/kibana-core
+/test/functional/page_objects/newsfeed_page.ts @elastic/kibana-core # assigned per https://github.com/elastic/kibana/pull/160210
+/test/functional/page_objects/home_page.ts @elastic/kibana-core
+/test/functional/fixtures/es_archiver/deprecations_service @elastic/kibana-core
+/test/health_gateway @elastic/kibana-core
+/test/api_integration/apis/saved_objects* @elastic/kibana-core
+/test/health_gateway @elastic/kibana-core
+/test/node_roles_functional @elastic/kibana-core
+/test/functional/firefox/home.config.ts @elastic/kibana-core
+/test/functional/apps/status_page/*.ts @elastic/kibana-core
+/test/functional/apps/bundles @elastic/kibana-core # Assigned per https://github.com/elastic/kibana/pull/64367
+/test/examples/hello_world @elastic/kibana-core
+/test/examples/routing/index.ts @elastic/kibana-core # Assigned per https://github.com/elastic/kibana/pull/69581
+/test/common/plugins/newsfeed @elastic/kibana-core
+/test/common/configure_http2.ts @elastic/kibana-core
+/test/api_integration/apis/ui_counters @elastic/kibana-core
+/test/api_integration/apis/telemetry @elastic/kibana-core
+/test/api_integration/apis/status @elastic/kibana-core
+/test/api_integration/apis/stats @elastic/kibana-core # Assigned per: https://github.com/elastic/kibana/pull/20577
+/test/api_integration/apis/saved_objects* @elastic/kibana-core
+/test/api_integration/apis/core/*.ts @elastic/kibana-core
/x-pack/test/functional/apps/saved_objects_management @elastic/kibana-core
/x-pack/test/usage_collection @elastic/kibana-core
/x-pack/test/licensing_plugin @elastic/kibana-core
@@ -1481,6 +1733,28 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib
#CC# /x-pack/plugins/translations/ @elastic/kibana-localization @elastic/kibana-core
# Kibana Platform Security
+# security
+/x-pack/test_serverless/functional/test_suites/observability/role_management @elastic/kibana-security
+/x-pack/test/functional/config_security_basic.ts @elastic/kibana-security
+/x-pack/test/functional/page_objects/user_profile_page.ts @elastic/kibana-security
+/x-pack/test/functional/page_objects/space_selector_page.ts @elastic/kibana-security
+/x-pack/test/functional/page_objects/security_page.ts @elastic/kibana-security
+/x-pack/test/functional/page_objects/role_mappings_page.ts @elastic/kibana-security
+/x-pack/test/functional/page_objects/copy_saved_objects_to_space_page.ts @elastic/kibana-security # Assigned per https://github.com/elastic/kibana/pull/39002
+/x-pack/test/functional/page_objects/api_keys_page.ts @elastic/kibana-security
+/x-pack/test/functional/page_objects/account_settings_page.ts @elastic/kibana-security
+/x-pack/test/functional/apps/user_profiles @elastic/kibana-security
+/x-pack/test/common/services/spaces.ts @elastic/kibana-security
+/x-pack/test/api_integration/config_security_*.ts @elastic/kibana-security
+/x-pack/test/functional/apps/api_keys @elastic/kibana-security
+/x-pack/test/ftr_apis/security_and_spaces @elastic/kibana-security
+/test/server_integration/services/supertest.js @elastic/kibana-security @elastic/kibana-core
+/test/server_integration/http/ssl @elastic/kibana-security # Assigned per https://github.com/elastic/kibana/pull/53810
+/test/server_integration/http/ssl_with_p12 @elastic/kibana-security # Assigned per https://github.com/elastic/kibana/pull/199795#discussion_r1846522206
+/test/server_integration/http/ssl_with_p12_intermediate @elastic/kibana-security # Assigned per https://github.com/elastic/kibana/pull/199795#discussion_r1846522206
+
+/test/server_integration/config.base.js @elastic/kibana-security @elastic/kibana-core # Assigned per https://github.com/elastic/kibana/pull/199795#discussion_r1846510782
+/test/server_integration/__fixtures__ @elastic/kibana-security # Assigned per https://github.com/elastic/kibana/pull/53810
/.github/codeql @elastic/kibana-security
/.github/workflows/codeql.yml @elastic/kibana-security
/.github/workflows/codeql-stats.yml @elastic/kibana-security
@@ -1518,12 +1792,33 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib
#CC# /x-pack/plugins/security/ @elastic/kibana-security
# Response Ops team
-/x-pack/test/examples/triggers_actions_ui_examples @elastic/response-ops
+/x-pack/test/plugin_api_perf @elastic/response-ops # Assigned per https://github.com/elastic/kibana/blob/assign-response-ops/x-pack/test/plugin_api_perf/plugins/task_manager_performance/kibana.jsonc#L4
+/x-pack/test/functional/page_objects/maintenance_windows_page.ts @elastic/response-ops
+/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/index.ts @elastic/response-ops
+/x-pack/test_serverless/functional/test_suites/observability/rules/rules_list.ts @elastic/response-ops
+/x-pack/test/functional_with_es_ssl/config.base.ts @elastic/response-ops # Assigned per https://github.com/elastic/kibana/pull/197070
+/x-pack/test/functional_with_es_ssl/lib/alert_api_actions.ts @elastic/response-ops
+/x-pack/test/functional_with_es_ssl/lib/get_test_data.ts @elastic/response-ops
+/x-pack/test/functional_with_es_ssl/page_objects/index.ts @elastic/response-ops # Assigned per git blame
+/x-pack/test/functional_with_es_ssl/page_objects/triggers_actions_ui_page.ts @elastic/response-ops
+/x-pack/test/functional_with_es_ssl/page_objects/rule_details.ts @elastic/response-ops
+/x-pack/test/functional_with_es_ssl/lib/object_remover.ts @elastic/response-ops
+/x-pack/test/stack_functional_integration/apps/alerts @elastic/response-ops
+/x-pack/test/functional/services/actions @elastic/response-ops
+/x-pack/test/api_integration_basic/apis/security_solution/index.ts @elastic/response-ops
+/x-pack/test/api_integration_basic/apis/security_solution/cases_privileges.ts @elastic/response-ops
+/x-pack/test/upgrade/services/rules_upgrade_services.ts @elastic/response-ops
+/x-pack/test/upgrade/apps/rules @elastic/response-ops
+/x-pack/test/examples/triggers_actions_ui_examples @elastic/response-ops # Assigned per https://github.com/elastic/kibana/blob/main/x-pack/examples/triggers_actions_ui_example/kibana.jsonc#L4
+/x-pack/test/functional/services/rules @elastic/response-ops
+/x-pack/test/plugin_api_integration/plugins/sample_task_plugin @elastic/response-ops
+/x-pack/test/functional/fixtures/kbn_archiver/cases @elastic/response-ops
+/x-pack/test/functional/es_archives/cases @elastic/response-ops
+/x-pack/test/functional_with_es_ssl/plugins/alerts @elastic/response-ops
/x-pack/test/functional_with_es_ssl/plugins/cases @elastic/response-ops
/x-pack/test/screenshot_creation/apps/response_ops_docs @elastic/response-ops
/x-pack/test/rule_registry @elastic/response-ops @elastic/obs-ux-management-team
/x-pack/test/accessibility/apps/group3/rules_connectors.ts @elastic/response-ops
-/x-pack/test/functional/es_archives/cases/default @elastic/response-ops
/x-pack/test_serverless/functional/page_objects/svl_triggers_actions_ui_page.ts @elastic/response-ops
/x-pack/test_serverless/functional/page_objects/svl_rule_details_ui_page.ts @elastic/response-ops
/x-pack/test_serverless/functional/page_objects/svl_oblt_overview_page.ts @elastic/response-ops
@@ -1561,6 +1856,11 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib
/x-pack/test/functional/es_archives/cases/signals/hosts_users @elastic/response-ops
# Enterprise Search
+# search
+/x-pack/test/functional_solution_sidenav/tests/search_sidenav.ts @elastic/search-kibana
+/x-pack/test/functional/services/search_sessions.ts @elastic/search-kibana
+/x-pack/test/functional/page_objects/search_* @elastic/search-kibana
+/x-pack/test/functional/apps/search_playground @elastic/search-kibana
/x-pack/test_serverless/functional/page_objects/svl_ingest_pipelines.ts @elastic/search-kibana
/x-pack/test/functional/apps/dev_tools/embedded_console.ts @elastic/search-kibana
/x-pack/test/functional/apps/ingest_pipelines/feature_controls/ingest_pipelines_security.ts @elastic/search-kibana
@@ -1577,18 +1877,51 @@ x-pack/test/api_integration/apis/management/index_management/inference_endpoints
/x-pack/test/functional_search/ @elastic/search-kibana
# Management Experience - Deployment Management
-/x-pack/test/api_integration/services/index_management.ts @elastic/kibana-management
-/x-pack/test/functional/apps/license_management @elastic/kibana-management
+/x-pack/test/functional/services/ace_editor.js @elastic/kibana-management
+/x-pack/test/functional/page_objects/remote_clusters_page.ts @elastic/kibana-management
+/x-pack/test/stack_functional_integration/apps/ccs @elastic/kibana-management
+/x-pack/test/functional/services/data_stream.ts @elastic/kibana-management
+/x-pack/test/functional/page_objects/watcher_page.ts @elastic/kibana-management
+/x-pack/test/functional/page_objects/upgrade_assistant_page.ts @elastic/kibana-management
+/x-pack/test/functional/page_objects/snapshot_restore_page.ts @elastic/kibana-management
+/x-pack/test/functional/page_objects/rollup_page.ts @elastic/kibana-management
+/x-pack/test/functional/page_objects/ingest_pipelines_page.ts @elastic/kibana-management
+/x-pack/test/functional/page_objects/grok_debugger_page.ts @elastic/kibana-management
+/x-pack/test/functional/page_objects/cross_cluster_replication_page.ts @elastic/kibana-management
+/x-pack/test/functional/fixtures/ingest_pipeline_example_mapping.csv @elastic/kibana-management
+/x-pack/test/functional/apps/snapshot_restore @elastic/kibana-management
/x-pack/test/functional/apps/painless_lab @elastic/kibana-management
+/x-pack/test_serverless/functional/test_suites/common/spaces/spaces_management.ts @elastic/kibana-management
+/x-pack/test/stack_functional_integration/apps/management @elastic/kibana-management
+/x-pack/test/functional/page_objects/*_management_page.ts @elastic/kibana-management
+/test/functional/services/saved_query_management_component.ts @elastic/kibana-management
+/test/functional/services/management @elastic/kibana-management
+/x-pack/test/functional/apps/cross_cluster_replication @elastic/kibana-management
+/x-pack/test/functional/apps/ingest_pipelines @elastic/kibana-management
+/x-pack/test/functional/apps/home @elastic/kibana-management
+/x-pack/test/functional/apps/license_management @elastic/kibana-management
/x-pack/test/functional/apps/management @elastic/kibana-management
+/x-pack/test/functional/apps/remote_clusters @elastic/kibana-management
+/x-pack/test/functional/apps/upgrade_assistant @elastic/kibana-management
+/x-pack/test/functional/apps/dev_tools @elastic/kibana-management
+/test/plugin_functional/test_suites/management @elastic/kibana-management
+/x-pack/test/upgrade_assistant_integration @elastic/kibana-management
+/test/plugin_functional/plugins/management_test_plugin @elastic/kibana-management
+/test/functional/page_objects/management/*.ts @elastic/kibana-management
+/test/functional/page_objects/embedded_console.ts @elastic/kibana-management
+/test/functional/page_objects/console_page.ts @elastic/kibana-management
+/test/functional/firefox/console.config.ts @elastic/kibana-management
+/test/functional/apps/management @elastic/kibana-management
+/test/functional/apps/saved_objects_management @elastic/kibana-management
+/test/functional/apps/console/*.ts @elastic/kibana-management
+/test/api_integration/apis/console/*.ts @elastic/kibana-management
+/test/accessibility/apps/management.ts @elastic/kibana-management
+/test/accessibility/apps/console.ts @elastic/kibana-management
/x-pack/test/api_integration/services/index_management.ts @elastic/kibana-management
/x-pack/test/functional/services/grok_debugger.js @elastic/kibana-management
-/x-pack/test/functional/apps/cross_cluster_replication @elastic/kibana-management
/x-pack/test/functional/apps/grok_debugger @elastic/kibana-management
/x-pack/test/functional/apps/index_lifecycle_management @elastic/kibana-management
/x-pack/test/functional/apps/index_management @elastic/kibana-management
-/x-pack/test/functional/apps/ingest_pipelines @elastic/kibana-management
-/x-pack/test/functional/apps/upgrade_assistant @elastic/kibana-management
/x-pack/test/api_integration/services/ingest_pipelines @elastic/kibana-management
/x-pack/test/functional/apps/watcher @elastic/kibana-management
/x-pack/test/api_integration/apis/watcher @elastic/kibana-management
@@ -1629,9 +1962,12 @@ x-pack/test/api_integration/apis/management/index_management/inference_endpoints
#CC# /x-pack/plugins/cross_cluster_replication/ @elastic/kibana-management
# Security Solution
+/x-pack/test/functional/es_archives/rule_exceptions @elastic/security-solution # Assigned per https://github.com/elastic/kibana/pull/199795/files/ae80bb252bc71f787c122849fcb9b01e386fc5e9#r1840233040
+/x-pack/test/functional_solution_sidenav/tests/security_sidenav.ts @elastic/security-solution
+/x-pack/test/common/utils/security_solution/index.ts @elastic/security-solution
+/x-pack/test/plugin_functional/plugins/resolver_test @elastic/security-solution
/x-pack/test/common/services/security_solution @elastic/security-solution
/x-pack/test/api_integration/services/security_solution_*.gen.ts @elastic/security-solution
-/x-pack/test_serverless/functional/test_suites/security/index.feature_flags.ts @elastic/security-solution
/x-pack/test/accessibility/apps/group3/security_solution.ts @elastic/security-solution
/x-pack/test_serverless/functional/test_suites/security/config.ts @elastic/security-solution @elastic/appex-qa
/x-pack/test_serverless/functional/test_suites/security/config.feature_flags.ts @elastic/security-solution
@@ -1913,6 +2249,7 @@ x-pack/test/security_solution_cypress/cypress/tasks/expandable_flyout @elastic/
/x-pack/plugins/security_solution/public/flyout/document_details/isolate_host/ @elastic/security-defend-workflows
/x-pack/plugins/security_solution/common/endpoint/ @elastic/security-defend-workflows
/x-pack/plugins/security_solution/common/api/endpoint/ @elastic/security-defend-workflows
+x-pack/plugins/security_solution/server/assistant/tools/defend_insights @elastic/security-defend-workflows
/x-pack/plugins/security_solution/server/endpoint/ @elastic/security-defend-workflows
/x-pack/plugins/security_solution/server/lists_integration/endpoint/ @elastic/security-defend-workflows
/x-pack/plugins/security_solution/server/lib/license/ @elastic/security-defend-workflows
@@ -1924,6 +2261,10 @@ x-pack/test/security_solution_cypress/cypress/tasks/expandable_flyout @elastic/
/x-pack/plugins/security_solution_serverless/public/upselling/sections/endpoint_management @elastic/security-defend-workflows
/x-pack/plugins/security_solution_serverless/public/upselling/pages/endpoint_management @elastic/security-defend-workflows
/x-pack/plugins/security_solution_serverless/server/endpoint @elastic/security-defend-workflows
+x-pack/packages/kbn-elastic-assistant-common/impl/schemas/defend_insights @elastic/security-defend-workflows
+x-pack/plugins/elastic_assistant/server/__mocks__/defend_insights_schema.mock.ts @elastic/security-defend-workflows
+x-pack/plugins/elastic_assistant/server/ai_assistant_data_clients/defend_insights @elastic/security-defend-workflows
+x-pack/plugins/elastic_assistant/server/routes/defend_insights @elastic/security-defend-workflows
## Security Solution sub teams - security-telemetry (Data Engineering)
x-pack/plugins/security_solution/server/usage/ @elastic/security-data-analytics
@@ -2005,8 +2346,10 @@ x-pack/plugins/security_solution/server/lib/security_integrations @elastic/secur
/x-pack/plugins/security_solution_serverless/**/*.scss @elastic/security-design
# Logstash
-/x-pack/test/api_integration/apis/logstash @elastic/logstash
+/x-pack/test/functional/services/pipeline_* @elastic/logstash
+/x-pack/test/functional/page_objects/logstash_page.ts @elastic/logstash
/x-pack/test/functional/apps/logstash @elastic/logstash
+/x-pack/test/api_integration/apis/logstash @elastic/logstash
#CC# /x-pack/plugins/logstash/ @elastic/logstash
# EUI team
@@ -2025,19 +2368,48 @@ x-pack/test/profiling_api_integration @elastic/obs-ux-infra_services-team
x-pack/plugins/observability_solution/observability_shared/public/components/profiling @elastic/obs-ux-infra_services-team
# Shared UX
-/test/api_integration/apis/guided_onboarding @elastic/appex-sharedux
+/test/api_integration/apis/short_url/**/*.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files#r1846654156
+/test/functional/page_objects/share_page.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files#r1846648444
+/test/accessibility/apps/kibana_overview_* @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files/cab99bce5ac2082fa77222beebe3b61ff836b94b#r1846659920
+/x-pack/test/functional/services/sample_data @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200142#discussion_r1846512756
+/test/functional/page_objects/files_management.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200017#discussion_r1840477291
+/test/accessibility/apps/home.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/199771/files#r1840077237
+/test/api_integration/apis/home/*.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/199771/files#r1840077065
+/test/functional/apps/home @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/199771/files#r1840075278
+/x-pack/test/plugin_functional/plugins/global_search_test @elastic/appex-sharedux
+/test/functional/services/saved_objects_finder.ts @elastic/appex-sharedux
+/test/functional/apps/kibana_overview @elastic/appex-sharedux
+/x-pack/test/functional_solution_sidenav/config.ts @elastic/appex-sharedux
+/x-pack/test/functional_solution_sidenav/ftr_provider_context.ts @elastic/appex-sharedux
+/x-pack/test/functional_solution_sidenav/services.ts @elastic/appex-sharedux
+/x-pack/test/functional_solution_sidenav/index.ts @elastic/appex-sharedux
+/x-pack/test/functional_cloud @elastic/appex-sharedux
+/x-pack/test/functional/services/user_menu.js @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/179270
+/x-pack/test/functional/page_objects/reporting_page.ts @elastic/appex-sharedux
+/x-pack/test/accessibility/apps/**/config.ts @elastic/appex-sharedux
+/x-pack/test/accessibility/apps/**/index.ts @elastic/appex-sharedux
+/x-pack/test/upgrade/apps/reporting @elastic/appex-sharedux
+/x-pack/test/functional/apps/advanced_settings @elastic/appex-sharedux
+/test/functional/services/monaco_editor.ts @elastic/appex-sharedux
+/x-pack/test/functional/fixtures/kbn_archiver/global_search @elastic/appex-sharedux
+/x-pack/test/plugin_functional/test_suites/global_search @elastic/appex-sharedux
/test/plugin_functional/test_suites/shared_ux @elastic/appex-sharedux
-/x-pack/test/functional/apps/advanced_settings @elastic/appex-sharedux @elastic/kibana-management
-/test/examples/content_management @elastic/appex-sharedux
/test/plugin_functional/plugins/kbn_sample_panel_action @elastic/appex-sharedux
-/test/functional/apps/kibana_overview @elastic/appex-sharedux
/test/plugin_functional/plugins/eui_provider_dev_warning @elastic/appex-sharedux
+/test/functional/page_objects/settings_page.ts @elastic/appex-sharedux
+/test/functional/apps/sharing/*.ts @elastic/appex-sharedux
+/test/functional/apps/kibana_overviews @elastic/appex-sharedux
+/test/examples/ui_actions/*.ts @elastic/appex-sharedux
+/test/examples/state_sync/*.ts @elastic/appex-sharedux
+/test/examples/error_boundary/index.ts @elastic/appex-sharedux
+/test/examples/content_management/*.ts @elastic/appex-sharedux
+/test/examples/bfetch_explorer/*.ts @elastic/appex-sharedux
+/test/api_integration/apis/guided_onboarding @elastic/appex-sharedux
/x-pack/test/banners_functional @elastic/appex-sharedux
/x-pack/test/custom_branding @elastic/appex-sharedux
-/x-pack/test/accessibility/apps/group3/snapshot_and_restore.ts @elastic/appex-sharedux
-/x-pack/test/accessibility/apps/group3/tags.ts @elastic/appex-sharedux
/x-pack/test/api_integration/apis/content_management @elastic/appex-sharedux
-/x-pack/test/functional_solution_sidenav @elastic/appex-sharedux
+/x-pack/test/accessibility/apps/group3/tags.ts @elastic/appex-sharedux
+/x-pack/test/accessibility/apps/group3/snapshot_and_restore.ts @elastic/appex-sharedux
/x-pack/test_serverless/functional/test_suites/common/spaces/spaces_selection.ts @elastic/appex-sharedux
/x-pack/test_serverless/functional/test_suites/common/spaces/index.ts @elastic/appex-sharedux
packages/react @elastic/appex-sharedux
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 737eedabadfa0..8ed73aa521aff 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,37 +5,26 @@ Summarize your PR. If it involves visual changes include a screenshot or gif.
### Checklist
-Delete any items that are not applicable to this PR.
+Check the PR satisfies following conditions.
+
+Reviewers should verify this PR satisfies this list as well.
- [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials
- [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
-- [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed
-- [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
-- [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
-- [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
-- [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers)
-
-
-### Risk Matrix
-
-Delete this section if it is not applicable to this PR.
+- [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations.
+- [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed
+- [ ] The PR description includes the appropriate Release Notes section, and the correct `release_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
-Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.
+### Identify risks
-When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:
+Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.
-| Risk | Probability | Severity | Mitigation/Notes |
-|---------------------------|-------------|----------|-------------------------|
-| Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. |
-| Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. |
-| Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. |
-| [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |
+Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.
+- [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
+- [ ] ...
-### For maintainers
-- [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)
-- [ ] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx
index 175109e8ee574..15ffcda0b1c93 100644
--- a/api_docs/actions.mdx
+++ b/api_docs/actions.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';
diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx
index 71fd5feadd788..794e351005fe7 100644
--- a/api_docs/advanced_settings.mdx
+++ b/api_docs/advanced_settings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';
diff --git a/api_docs/ai_assistant_management_selection.mdx b/api_docs/ai_assistant_management_selection.mdx
index fab12162494d5..cde3c9b45a280 100644
--- a/api_docs/ai_assistant_management_selection.mdx
+++ b/api_docs/ai_assistant_management_selection.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection
title: "aiAssistantManagementSelection"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiAssistantManagementSelection plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
---
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';
diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx
index cfc17d909a2a7..45469c9641ea4 100644
--- a/api_docs/aiops.mdx
+++ b/api_docs/aiops.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';
diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx
index b5fc392643171..c8db2b8506b22 100644
--- a/api_docs/alerting.mdx
+++ b/api_docs/alerting.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx
index af20da1424a5c..f32c0ac5d97c1 100644
--- a/api_docs/apm.mdx
+++ b/api_docs/apm.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';
diff --git a/api_docs/apm_data_access.mdx b/api_docs/apm_data_access.mdx
index 0f2f4a21afea3..c8df2802feb6f 100644
--- a/api_docs/apm_data_access.mdx
+++ b/api_docs/apm_data_access.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
title: "apmDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apmDataAccess plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';
diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx
index b484db15c54f4..87f3d70b86cab 100644
--- a/api_docs/banners.mdx
+++ b/api_docs/banners.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
title: "banners"
image: https://source.unsplash.com/400x175/?github
description: API docs for the banners plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';
diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx
index 8e9f37c98ae6c..e6a4379488f5d 100644
--- a/api_docs/bfetch.mdx
+++ b/api_docs/bfetch.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
import bfetchObj from './bfetch.devdocs.json';
diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx
index cb568ffd1ce34..a3d554bb36e2f 100644
--- a/api_docs/canvas.mdx
+++ b/api_docs/canvas.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
title: "canvas"
image: https://source.unsplash.com/400x175/?github
description: API docs for the canvas plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';
diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx
index ed47aed23ee06..89669e6216ab4 100644
--- a/api_docs/cases.mdx
+++ b/api_docs/cases.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';
diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx
index c1e1906fec160..eb3f0a727f824 100644
--- a/api_docs/charts.mdx
+++ b/api_docs/charts.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';
diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx
index 42a9d13f4970a..d3f43e2fcfa23 100644
--- a/api_docs/cloud.mdx
+++ b/api_docs/cloud.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';
diff --git a/api_docs/cloud_data_migration.mdx b/api_docs/cloud_data_migration.mdx
index e38c8fadc5bc3..966039815d5a9 100644
--- a/api_docs/cloud_data_migration.mdx
+++ b/api_docs/cloud_data_migration.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
diff --git a/api_docs/cloud_defend.mdx b/api_docs/cloud_defend.mdx
index 29a981392716c..99e2ba8117d16 100644
--- a/api_docs/cloud_defend.mdx
+++ b/api_docs/cloud_defend.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.devdocs.json';
diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx
index 207e6cf0676eb..bb0ce2f47ee82 100644
--- a/api_docs/cloud_security_posture.mdx
+++ b/api_docs/cloud_security_posture.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
title: "cloudSecurityPosture"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudSecurityPosture plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
diff --git a/api_docs/console.mdx b/api_docs/console.mdx
index d7ab3e4e2ed99..b7b69f1fe6d44 100644
--- a/api_docs/console.mdx
+++ b/api_docs/console.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
title: "console"
image: https://source.unsplash.com/400x175/?github
description: API docs for the console plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';
diff --git a/api_docs/content_management.devdocs.json b/api_docs/content_management.devdocs.json
index 3c2f55ee37ecd..2b8f43fac75ea 100644
--- a/api_docs/content_management.devdocs.json
+++ b/api_docs/content_management.devdocs.json
@@ -2015,7 +2015,22 @@
"path": "src/plugins/content_management/server/types.ts",
"deprecated": false,
"trackAdoption": false,
- "children": [],
+ "children": [
+ {
+ "parentPluginId": "contentManagement",
+ "id": "def-server.ContentManagementServerSetup.favorites",
+ "type": "Object",
+ "tags": [],
+ "label": "favorites",
+ "description": [],
+ "signature": [
+ "{ registerFavoriteType: (type: string, config?: FavoriteTypeConfig) => void; }"
+ ],
+ "path": "src/plugins/content_management/server/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
"lifecycle": "setup",
"initialIsOpen": true
},
diff --git a/api_docs/content_management.mdx b/api_docs/content_management.mdx
index 24c41af4e1445..566e4d3b547cb 100644
--- a/api_docs/content_management.mdx
+++ b/api_docs/content_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 149 | 0 | 125 | 6 |
+| 150 | 0 | 126 | 6 |
## Client
diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx
index 2cf5290a865eb..04d154ce26f2a 100644
--- a/api_docs/controls.mdx
+++ b/api_docs/controls.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls
title: "controls"
image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';
diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx
index 55a09921a86e7..7a4445adf130c 100644
--- a/api_docs/custom_integrations.mdx
+++ b/api_docs/custom_integrations.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github
description: API docs for the customIntegrations plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
import customIntegrationsObj from './custom_integrations.devdocs.json';
diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx
index 08107ebb2e9e7..c5850f35f0236 100644
--- a/api_docs/dashboard.mdx
+++ b/api_docs/dashboard.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
import dashboardObj from './dashboard.devdocs.json';
diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx
index 5c0b5bd5a3db1..afc96b9710028 100644
--- a/api_docs/dashboard_enhanced.mdx
+++ b/api_docs/dashboard_enhanced.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboardEnhanced plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';
diff --git a/api_docs/data.mdx b/api_docs/data.mdx
index 2e18c1dff9d3c..1201d7bf57eb0 100644
--- a/api_docs/data.mdx
+++ b/api_docs/data.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';
diff --git a/api_docs/data_quality.mdx b/api_docs/data_quality.mdx
index 04def9b4677e6..48a744edd86f6 100644
--- a/api_docs/data_quality.mdx
+++ b/api_docs/data_quality.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataQuality
title: "dataQuality"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataQuality plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataQuality']
---
import dataQualityObj from './data_quality.devdocs.json';
diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx
index 444505de0adbc..dff7c532d9a36 100644
--- a/api_docs/data_query.mdx
+++ b/api_docs/data_query.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';
diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx
index e850c5040ad90..98991a193f217 100644
--- a/api_docs/data_search.mdx
+++ b/api_docs/data_search.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';
diff --git a/api_docs/data_usage.mdx b/api_docs/data_usage.mdx
index b8ac5ad70d155..aa57bb5b18841 100644
--- a/api_docs/data_usage.mdx
+++ b/api_docs/data_usage.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataUsage
title: "dataUsage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataUsage plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataUsage']
---
import dataUsageObj from './data_usage.devdocs.json';
diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx
index bef1193c25542..59124e672fe7e 100644
--- a/api_docs/data_view_editor.mdx
+++ b/api_docs/data_view_editor.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
title: "dataViewEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewEditor plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
---
import dataViewEditorObj from './data_view_editor.devdocs.json';
diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx
index 9fd9625444311..9fdb5bf3b0b9b 100644
--- a/api_docs/data_view_field_editor.mdx
+++ b/api_docs/data_view_field_editor.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
title: "dataViewFieldEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewFieldEditor plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';
diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx
index 0773eed1fd651..63de40341cc8b 100644
--- a/api_docs/data_view_management.mdx
+++ b/api_docs/data_view_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
title: "dataViewManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';
diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx
index d80de53055c29..9361036078db5 100644
--- a/api_docs/data_views.mdx
+++ b/api_docs/data_views.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';
diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx
index ecdcbe79db8da..6bfc35dc21917 100644
--- a/api_docs/data_visualizer.mdx
+++ b/api_docs/data_visualizer.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
title: "dataVisualizer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataVisualizer plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
---
import dataVisualizerObj from './data_visualizer.devdocs.json';
diff --git a/api_docs/dataset_quality.mdx b/api_docs/dataset_quality.mdx
index 6effae28bd2df..8e4d2eae5adb4 100644
--- a/api_docs/dataset_quality.mdx
+++ b/api_docs/dataset_quality.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality
title: "datasetQuality"
image: https://source.unsplash.com/400x175/?github
description: API docs for the datasetQuality plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
---
import datasetQualityObj from './dataset_quality.devdocs.json';
diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx
index de67f78986d07..fbcf91dfb05c5 100644
--- a/api_docs/deprecations_by_api.mdx
+++ b/api_docs/deprecations_by_api.mdx
@@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx
index c866227d76f72..ccd10e2cfe25b 100644
--- a/api_docs/deprecations_by_plugin.mdx
+++ b/api_docs/deprecations_by_plugin.mdx
@@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@@ -390,7 +390,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| | [hover.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/hover/hover.ts#:~:text=modes) | - |
-| | [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode) | - |
+| | [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode) | - |
@@ -1370,16 +1370,16 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| | [links.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/links.ts#:~:text=authc), [hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/lib/kibana/hooks.ts#:~:text=authc) | - |
| | [use_bulk_get_user_profiles.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/user_profiles/use_bulk_get_user_profiles.tsx#:~:text=userProfiles), [use_get_current_user_profile.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/user_profiles/use_get_current_user_profile.tsx#:~:text=userProfiles) | - |
| | [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=audit), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/plugin.ts#:~:text=audit), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/plugin.ts#:~:text=audit) | - |
-| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [trusted_app_validator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/trusted_app_validator.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [trusted_app_validator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/trusted_app_validator.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [exceptions_list_item_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [exceptions_list_item_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID)+ 22 more | - |
+| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [trusted_apps_http_mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/mocks/trusted_apps_http_mocks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [trusted_apps_http_mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/mocks/trusted_apps_http_mocks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [trusted_apps_http_mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/mocks/trusted_apps_http_mocks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [mappers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/mappers.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID)+ 18 more | - |
| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_NAME), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_NAME) | - |
| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION) | - |
-| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form.tsx#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form.tsx#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/view/utils.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/view/utils.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [service_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/service/service_actions.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [service_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/service/service_actions.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [service_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/service/service_actions.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID)+ 21 more | - |
+| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form.tsx#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form.tsx#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/view/utils.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/view/utils.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [service_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/service/service_actions.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [service_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/service/service_actions.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID), [service_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/service/service_actions.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_ID)+ 19 more | - |
| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_NAME), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_NAME), [create_event_filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_event_filters.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_NAME), [create_event_filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_event_filters.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/event_filters/index.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/event_filters/index.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_NAME) | - |
| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_DESCRIPTION), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_DESCRIPTION), [create_event_filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_event_filters.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_DESCRIPTION), [create_event_filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_event_filters.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/event_filters/index.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/event_filters/index.ts#:~:text=ENDPOINT_EVENT_FILTERS_LIST_DESCRIPTION) | - |
-| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/host_isolation_exceptions/constants.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/host_isolation_exceptions/constants.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [host_isolation_exceptions_validator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/host_isolation_exceptions_validator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [host_isolation_exceptions_validator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/host_isolation_exceptions_validator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [exceptions_list_item_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [exceptions_list_item_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [host_isolation_exception_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/host_isolation_exception_generator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [host_isolation_exception_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/host_isolation_exception_generator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID)+ 5 more | - |
+| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/host_isolation_exceptions/constants.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/host_isolation_exceptions/constants.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [host_isolation_exceptions_validator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/host_isolation_exceptions_validator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [host_isolation_exceptions_validator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/host_isolation_exceptions_validator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [host_isolation_exception_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/host_isolation_exception_generator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [host_isolation_exception_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/host_isolation_exception_generator.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/host_isolation_exceptions/index.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/host_isolation_exceptions/index.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_ID)+ 3 more | - |
| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/host_isolation_exceptions/constants.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_NAME), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/host_isolation_exceptions/constants.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/host_isolation_exceptions/index.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/host_isolation_exceptions/index.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_NAME) | - |
| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/host_isolation_exceptions/constants.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_DESCRIPTION), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/host_isolation_exceptions/constants.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/host_isolation_exceptions/index.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/host_isolation_exceptions/index.ts#:~:text=ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_DESCRIPTION) | - |
-| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [exceptions_list_item_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [exceptions_list_item_generator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID)+ 3 more | - |
+| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [lists.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [lists.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID)+ 1 more | - |
| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_NAME), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_NAME) | - |
| | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION) | - |
| | [use_colors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/resolver/view/use_colors.ts#:~:text=darkMode), [use_colors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/resolver/view/use_colors.ts#:~:text=darkMode), [use_colors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/resolver/view/use_colors.ts#:~:text=darkMode), [use_colors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/resolver/view/use_colors.ts#:~:text=darkMode), [use_colors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/resolver/view/use_colors.ts#:~:text=darkMode) | - |
diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx
index 54f393920f3e1..2a7eb147ca9cd 100644
--- a/api_docs/deprecations_by_team.mdx
+++ b/api_docs/deprecations_by_team.mdx
@@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx
index 80931a4878b48..e5377fb8c2d3f 100644
--- a/api_docs/dev_tools.mdx
+++ b/api_docs/dev_tools.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the devTools plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';
diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx
index 0467c61ec9471..e99b433dfbc38 100644
--- a/api_docs/discover.mdx
+++ b/api_docs/discover.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';
diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx
index 11026ca767650..fd3da7356071b 100644
--- a/api_docs/discover_enhanced.mdx
+++ b/api_docs/discover_enhanced.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
title: "discoverEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverEnhanced plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';
diff --git a/api_docs/discover_shared.devdocs.json b/api_docs/discover_shared.devdocs.json
index b1d4ffc320ed3..bc05a07a26fee 100644
--- a/api_docs/discover_shared.devdocs.json
+++ b/api_docs/discover_shared.devdocs.json
@@ -131,7 +131,9 @@
"docId": "kibDiscoverSharedPluginApi",
"section": "def-public.ObservabilityLogsAIAssistantFeature",
"text": "ObservabilityLogsAIAssistantFeature"
- }
+ },
+ " | ",
+ "ObservabilityCreateSLOFeature"
],
"path": "src/plugins/discover_shared/public/services/discover_features/types.ts",
"deprecated": false,
diff --git a/api_docs/discover_shared.mdx b/api_docs/discover_shared.mdx
index 7a1413d76ddd4..2c704f162afb0 100644
--- a/api_docs/discover_shared.mdx
+++ b/api_docs/discover_shared.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverShared
title: "discoverShared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverShared plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverShared']
---
import discoverSharedObj from './discover_shared.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 16 | 0 | 15 | 2 |
+| 16 | 0 | 15 | 3 |
## Client
diff --git a/api_docs/ecs_data_quality_dashboard.mdx b/api_docs/ecs_data_quality_dashboard.mdx
index 87015100abaa0..fa35eb3dc4311 100644
--- a/api_docs/ecs_data_quality_dashboard.mdx
+++ b/api_docs/ecs_data_quality_dashboard.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
title: "ecsDataQualityDashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ecsDataQualityDashboard plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';
diff --git a/api_docs/elastic_assistant.mdx b/api_docs/elastic_assistant.mdx
index ba00aa8504012..214643c86d4fd 100644
--- a/api_docs/elastic_assistant.mdx
+++ b/api_docs/elastic_assistant.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/elasticAssistant
title: "elasticAssistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the elasticAssistant plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
---
import elasticAssistantObj from './elastic_assistant.devdocs.json';
diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx
index a3ff24124d2c1..eb73d8a16367a 100644
--- a/api_docs/embeddable.mdx
+++ b/api_docs/embeddable.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';
diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx
index 4975071aa9071..a0a77ff91bce6 100644
--- a/api_docs/embeddable_enhanced.mdx
+++ b/api_docs/embeddable_enhanced.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
title: "embeddableEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableEnhanced plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';
diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx
index d8d808e5dca8e..3ec4dc1bbc1a8 100644
--- a/api_docs/encrypted_saved_objects.mdx
+++ b/api_docs/encrypted_saved_objects.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx
index 4780b780c94f2..bb8a84fc6707e 100644
--- a/api_docs/enterprise_search.mdx
+++ b/api_docs/enterprise_search.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
title: "enterpriseSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the enterpriseSearch plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';
diff --git a/api_docs/entities_data_access.mdx b/api_docs/entities_data_access.mdx
index 805e5145b0ba5..2c038dc679e6c 100644
--- a/api_docs/entities_data_access.mdx
+++ b/api_docs/entities_data_access.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entitiesDataAccess
title: "entitiesDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the entitiesDataAccess plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entitiesDataAccess']
---
import entitiesDataAccessObj from './entities_data_access.devdocs.json';
diff --git a/api_docs/entity_manager.mdx b/api_docs/entity_manager.mdx
index 51f1e320a3eec..ccc097f34276b 100644
--- a/api_docs/entity_manager.mdx
+++ b/api_docs/entity_manager.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entityManager
title: "entityManager"
image: https://source.unsplash.com/400x175/?github
description: API docs for the entityManager plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entityManager']
---
import entityManagerObj from './entity_manager.devdocs.json';
diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx
index 79c668b7f897d..4edcc3f06209b 100644
--- a/api_docs/es_ui_shared.mdx
+++ b/api_docs/es_ui_shared.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
title: "esUiShared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esUiShared plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
---
import esUiSharedObj from './es_ui_shared.devdocs.json';
diff --git a/api_docs/esql.mdx b/api_docs/esql.mdx
index 11daad068a9d1..d4214278b40f0 100644
--- a/api_docs/esql.mdx
+++ b/api_docs/esql.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esql
title: "esql"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esql plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esql']
---
import esqlObj from './esql.devdocs.json';
diff --git a/api_docs/esql_data_grid.mdx b/api_docs/esql_data_grid.mdx
index a67299f91a343..605066c06cb5f 100644
--- a/api_docs/esql_data_grid.mdx
+++ b/api_docs/esql_data_grid.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esqlDataGrid
title: "esqlDataGrid"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esqlDataGrid plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esqlDataGrid']
---
import esqlDataGridObj from './esql_data_grid.devdocs.json';
diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx
index 3bba1732013ef..58c1d189c6f4e 100644
--- a/api_docs/event_annotation.mdx
+++ b/api_docs/event_annotation.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';
diff --git a/api_docs/event_annotation_listing.mdx b/api_docs/event_annotation_listing.mdx
index 4d6169a2f569f..b4755e1ecc65a 100644
--- a/api_docs/event_annotation_listing.mdx
+++ b/api_docs/event_annotation_listing.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotationListing
title: "eventAnnotationListing"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotationListing plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
---
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';
diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx
index 28282dcc63e0a..a92f4b64c6ece 100644
--- a/api_docs/event_log.mdx
+++ b/api_docs/event_log.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
---
import eventLogObj from './event_log.devdocs.json';
diff --git a/api_docs/exploratory_view.mdx b/api_docs/exploratory_view.mdx
index 0c9d906e51c2a..177b9f6d5a490 100644
--- a/api_docs/exploratory_view.mdx
+++ b/api_docs/exploratory_view.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView
title: "exploratoryView"
image: https://source.unsplash.com/400x175/?github
description: API docs for the exploratoryView plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.devdocs.json';
diff --git a/api_docs/expression_error.devdocs.json b/api_docs/expression_error.devdocs.json
index d1652a5e8550d..62ffbcbfcbc9b 100644
--- a/api_docs/expression_error.devdocs.json
+++ b/api_docs/expression_error.devdocs.json
@@ -125,7 +125,7 @@
"label": "getDebugRenderer",
"description": [],
"signature": [
- "(theme$?: ",
+ "(theme$: ",
"Observable",
"<",
{
@@ -185,7 +185,7 @@
"label": "getErrorRenderer",
"description": [],
"signature": [
- "(theme$?: ",
+ "(theme$: ",
"Observable",
"<",
{
diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx
index bb17fa791f8ec..6aa589c37d0fc 100644
--- a/api_docs/expression_error.mdx
+++ b/api_docs/expression_error.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
import expressionErrorObj from './expression_error.devdocs.json';
diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx
index a544c00f18607..248364b05143f 100644
--- a/api_docs/expression_gauge.mdx
+++ b/api_docs/expression_gauge.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge
title: "expressionGauge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionGauge plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
---
import expressionGaugeObj from './expression_gauge.devdocs.json';
diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx
index 5462e44b2d280..c9b6d3e8a4bea 100644
--- a/api_docs/expression_heatmap.mdx
+++ b/api_docs/expression_heatmap.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';
diff --git a/api_docs/expression_image.devdocs.json b/api_docs/expression_image.devdocs.json
index cd97cdcab7462..538b4756896a0 100644
--- a/api_docs/expression_image.devdocs.json
+++ b/api_docs/expression_image.devdocs.json
@@ -11,7 +11,7 @@
"label": "getImageRenderer",
"description": [],
"signature": [
- "(theme$?: ",
+ "(theme$: ",
"Observable",
"<",
{
diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx
index 3b389eb66484f..6946b78c84f09 100644
--- a/api_docs/expression_image.mdx
+++ b/api_docs/expression_image.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
title: "expressionImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
import expressionImageObj from './expression_image.devdocs.json';
diff --git a/api_docs/expression_legacy_metric_vis.mdx b/api_docs/expression_legacy_metric_vis.mdx
index ff98ffd405b40..4cfa3f7e9de51 100644
--- a/api_docs/expression_legacy_metric_vis.mdx
+++ b/api_docs/expression_legacy_metric_vis.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
title: "expressionLegacyMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionLegacyMetricVis plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';
diff --git a/api_docs/expression_metric.devdocs.json b/api_docs/expression_metric.devdocs.json
index e8189d6563dba..22138d1d9d741 100644
--- a/api_docs/expression_metric.devdocs.json
+++ b/api_docs/expression_metric.devdocs.json
@@ -11,7 +11,7 @@
"label": "getMetricRenderer",
"description": [],
"signature": [
- "(theme$?: ",
+ "(theme$: ",
"Observable",
"<",
{
diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx
index 14696191f6783..6c6c3000d10a6 100644
--- a/api_docs/expression_metric.mdx
+++ b/api_docs/expression_metric.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
title: "expressionMetric"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
import expressionMetricObj from './expression_metric.devdocs.json';
diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx
index 7313a1db2de65..d96b4db3ffa39 100644
--- a/api_docs/expression_metric_vis.mdx
+++ b/api_docs/expression_metric_vis.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
title: "expressionMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';
diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx
index 889318c948dd0..54764722481de 100644
--- a/api_docs/expression_partition_vis.mdx
+++ b/api_docs/expression_partition_vis.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
title: "expressionPartitionVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionPartitionVis plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';
diff --git a/api_docs/expression_repeat_image.devdocs.json b/api_docs/expression_repeat_image.devdocs.json
index 52ed8295927b5..10a6801189d81 100644
--- a/api_docs/expression_repeat_image.devdocs.json
+++ b/api_docs/expression_repeat_image.devdocs.json
@@ -11,7 +11,7 @@
"label": "getRepeatImageRenderer",
"description": [],
"signature": [
- "(theme$?: ",
+ "(theme$: ",
"Observable",
"<",
{
diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx
index f0273b61d29c2..c697f7294ed75 100644
--- a/api_docs/expression_repeat_image.mdx
+++ b/api_docs/expression_repeat_image.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
title: "expressionRepeatImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRepeatImage plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';
diff --git a/api_docs/expression_reveal_image.devdocs.json b/api_docs/expression_reveal_image.devdocs.json
index de4fda2827e3d..bc0a3212309f8 100644
--- a/api_docs/expression_reveal_image.devdocs.json
+++ b/api_docs/expression_reveal_image.devdocs.json
@@ -11,7 +11,7 @@
"label": "getRevealImageRenderer",
"description": [],
"signature": [
- "(theme$?: ",
+ "(theme$: ",
"Observable",
"<",
{
diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx
index 73c97445f27ca..66c7479849e76 100644
--- a/api_docs/expression_reveal_image.mdx
+++ b/api_docs/expression_reveal_image.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
title: "expressionRevealImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRevealImage plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';
diff --git a/api_docs/expression_shape.devdocs.json b/api_docs/expression_shape.devdocs.json
index 68e74f630e34d..2c47953861b51 100644
--- a/api_docs/expression_shape.devdocs.json
+++ b/api_docs/expression_shape.devdocs.json
@@ -35,7 +35,7 @@
"label": "getProgressRenderer",
"description": [],
"signature": [
- "(theme$?: ",
+ "(theme$: ",
"Observable",
"<",
{
@@ -103,7 +103,7 @@
"label": "getShapeRenderer",
"description": [],
"signature": [
- "(theme$?: ",
+ "(theme$: ",
"Observable",
"<",
{
diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx
index 83e82cef5f501..5673b23367a73 100644
--- a/api_docs/expression_shape.mdx
+++ b/api_docs/expression_shape.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
title: "expressionShape"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
import expressionShapeObj from './expression_shape.devdocs.json';
diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx
index 2567dae00d53e..8725c8a4feee0 100644
--- a/api_docs/expression_tagcloud.mdx
+++ b/api_docs/expression_tagcloud.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
title: "expressionTagcloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';
diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx
index 4d87dc940a59a..b42ed0eb9a953 100644
--- a/api_docs/expression_x_y.mdx
+++ b/api_docs/expression_x_y.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY
title: "expressionXY"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionXY plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
import expressionXYObj from './expression_x_y.devdocs.json';
diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx
index bf030588c88e3..a281303cf1a2c 100644
--- a/api_docs/expressions.mdx
+++ b/api_docs/expressions.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
import expressionsObj from './expressions.devdocs.json';
diff --git a/api_docs/features.mdx b/api_docs/features.mdx
index 6062a86409c37..f85a2f3d784d9 100644
--- a/api_docs/features.mdx
+++ b/api_docs/features.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
title: "features"
image: https://source.unsplash.com/400x175/?github
description: API docs for the features plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
---
import featuresObj from './features.devdocs.json';
diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx
index 9e35f804e622d..ab83dedcd01a5 100644
--- a/api_docs/field_formats.mdx
+++ b/api_docs/field_formats.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';
diff --git a/api_docs/fields_metadata.mdx b/api_docs/fields_metadata.mdx
index e9a5b46a67ff3..bf531aea5845c 100644
--- a/api_docs/fields_metadata.mdx
+++ b/api_docs/fields_metadata.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldsMetadata
title: "fieldsMetadata"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldsMetadata plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldsMetadata']
---
import fieldsMetadataObj from './fields_metadata.devdocs.json';
diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx
index c3d4527358d94..63582ce718e59 100644
--- a/api_docs/file_upload.mdx
+++ b/api_docs/file_upload.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
title: "fileUpload"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fileUpload plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';
diff --git a/api_docs/files.mdx b/api_docs/files.mdx
index eef083f9d37ab..f8e261028bb21 100644
--- a/api_docs/files.mdx
+++ b/api_docs/files.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files
title: "files"
image: https://source.unsplash.com/400x175/?github
description: API docs for the files plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';
diff --git a/api_docs/files_management.mdx b/api_docs/files_management.mdx
index a5803c0f3b60a..2b63158df2b2e 100644
--- a/api_docs/files_management.mdx
+++ b/api_docs/files_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the filesManagement plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';
diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json
index 95969d738570b..44cdbaf201098 100644
--- a/api_docs/fleet.devdocs.json
+++ b/api_docs/fleet.devdocs.json
@@ -6197,7 +6197,7 @@
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
},
- ", pathPrefix: string | undefined) => Promise<",
+ " | undefined, pathPrefix: string | undefined) => Promise<",
"MappingRuntimeFields",
">"
],
@@ -6219,12 +6219,13 @@
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
- }
+ },
+ " | undefined"
],
"path": "x-pack/plugins/fleet/server/services/agents/build_status_runtime_field.ts",
"deprecated": false,
"trackAdoption": false,
- "isRequired": true
+ "isRequired": false
},
{
"parentPluginId": "fleet",
@@ -6597,6 +6598,74 @@
}
],
"returnComment": []
+ },
+ {
+ "parentPluginId": "fleet",
+ "id": "def-server.AgentClient.getLatestAgentAvailableBaseVersion",
+ "type": "Function",
+ "tags": [],
+ "label": "getLatestAgentAvailableBaseVersion",
+ "description": [
+ "\nReturn the latest agent available version, not taking into account IAR versions"
+ ],
+ "signature": [
+ "(includeCurrentVersion?: boolean | undefined) => Promise"
+ ],
+ "path": "x-pack/plugins/fleet/server/services/agents/agent_service.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "fleet",
+ "id": "def-server.AgentClient.getLatestAgentAvailableBaseVersion.$1",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "includeCurrentVersion",
+ "description": [],
+ "signature": [
+ "boolean | undefined"
+ ],
+ "path": "x-pack/plugins/fleet/server/services/agents/agent_service.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": false
+ }
+ ],
+ "returnComment": []
+ },
+ {
+ "parentPluginId": "fleet",
+ "id": "def-server.AgentClient.getLatestAgentAvailableDockerImageVersion",
+ "type": "Function",
+ "tags": [],
+ "label": "getLatestAgentAvailableDockerImageVersion",
+ "description": [
+ "\nReturn the latest agent available version formatted for the docker image"
+ ],
+ "signature": [
+ "(includeCurrentVersion?: boolean | undefined) => Promise"
+ ],
+ "path": "x-pack/plugins/fleet/server/services/agents/agent_service.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "fleet",
+ "id": "def-server.AgentClient.getLatestAgentAvailableDockerImageVersion.$1",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "includeCurrentVersion",
+ "description": [],
+ "signature": [
+ "boolean | undefined"
+ ],
+ "path": "x-pack/plugins/fleet/server/services/agents/agent_service.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": false
+ }
+ ],
+ "returnComment": []
}
],
"initialIsOpen": false
@@ -20174,6 +20243,54 @@
"returnComment": [],
"initialIsOpen": false
},
+ {
+ "parentPluginId": "fleet",
+ "id": "def-common.getSortConfig",
+ "type": "Function",
+ "tags": [],
+ "label": "getSortConfig",
+ "description": [],
+ "signature": [
+ "(sortField: string, sortOrder: \"asc\" | \"desc\") => Record[]"
+ ],
+ "path": "x-pack/plugins/fleet/common/services/agent_utils.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "fleet",
+ "id": "def-common.getSortConfig.$1",
+ "type": "string",
+ "tags": [],
+ "label": "sortField",
+ "description": [],
+ "signature": [
+ "string"
+ ],
+ "path": "x-pack/plugins/fleet/common/services/agent_utils.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ },
+ {
+ "parentPluginId": "fleet",
+ "id": "def-common.getSortConfig.$2",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "sortOrder",
+ "description": [],
+ "signature": [
+ "\"asc\" | \"desc\""
+ ],
+ "path": "x-pack/plugins/fleet/common/services/agent_utils.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
+ },
{
"parentPluginId": "fleet",
"id": "def-common.isValidDataset",
@@ -20284,6 +20401,39 @@
],
"returnComment": [],
"initialIsOpen": false
+ },
+ {
+ "parentPluginId": "fleet",
+ "id": "def-common.removeSOAttributes",
+ "type": "Function",
+ "tags": [],
+ "label": "removeSOAttributes",
+ "description": [],
+ "signature": [
+ "(kuery: string) => string"
+ ],
+ "path": "x-pack/plugins/fleet/common/services/agent_utils.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "fleet",
+ "id": "def-common.removeSOAttributes.$1",
+ "type": "string",
+ "tags": [],
+ "label": "kuery",
+ "description": [],
+ "signature": [
+ "string"
+ ],
+ "path": "x-pack/plugins/fleet/common/services/agent_utils.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
}
],
"interfaces": [
diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx
index 70490f528884f..00999c00d8251 100644
--- a/api_docs/fleet.mdx
+++ b/api_docs/fleet.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 1418 | 5 | 1295 | 81 |
+| 1427 | 5 | 1302 | 81 |
## Client
diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx
index 98d024e5931bd..78b526ba751eb 100644
--- a/api_docs/global_search.mdx
+++ b/api_docs/global_search.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch
title: "globalSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the globalSearch plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';
diff --git a/api_docs/guided_onboarding.mdx b/api_docs/guided_onboarding.mdx
index bde1a1c44e74a..15dc75c8db520 100644
--- a/api_docs/guided_onboarding.mdx
+++ b/api_docs/guided_onboarding.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding
title: "guidedOnboarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the guidedOnboarding plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';
diff --git a/api_docs/home.mdx b/api_docs/home.mdx
index fbb6e1f0419c7..520030ad4c702 100644
--- a/api_docs/home.mdx
+++ b/api_docs/home.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home
title: "home"
image: https://source.unsplash.com/400x175/?github
description: API docs for the home plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
---
import homeObj from './home.devdocs.json';
diff --git a/api_docs/image_embeddable.mdx b/api_docs/image_embeddable.mdx
index f6bd7e6ab6d1d..c9509b74857f4 100644
--- a/api_docs/image_embeddable.mdx
+++ b/api_docs/image_embeddable.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
title: "imageEmbeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the imageEmbeddable plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.devdocs.json';
diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx
index c2f59ac5f0b65..f8e4c358ce3b1 100644
--- a/api_docs/index_lifecycle_management.mdx
+++ b/api_docs/index_lifecycle_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
title: "indexLifecycleManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexLifecycleManagement plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';
diff --git a/api_docs/index_management.devdocs.json b/api_docs/index_management.devdocs.json
index d669189fc7e2a..ca65364f8319b 100644
--- a/api_docs/index_management.devdocs.json
+++ b/api_docs/index_management.devdocs.json
@@ -392,6 +392,20 @@
"path": "x-pack/packages/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "indexManagement",
+ "id": "def-public.IndexMappingProps.hasUpdateMappingsPrivilege",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "hasUpdateMappingsPrivilege",
+ "description": [],
+ "signature": [
+ "boolean | undefined"
+ ],
+ "path": "x-pack/packages/index-management/index_management_shared_types/src/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
@@ -3141,6 +3155,20 @@
"deprecated": false,
"trackAdoption": false
},
+ {
+ "parentPluginId": "indexManagement",
+ "id": "def-common.TemplateDeserialized.indexMode",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "indexMode",
+ "description": [],
+ "signature": [
+ "\"standard\" | \"time_series\" | \"logsdb\""
+ ],
+ "path": "x-pack/plugins/index_management/common/types/templates.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.ilmPolicy",
@@ -3677,6 +3705,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
+ {
+ "parentPluginId": "indexManagement",
+ "id": "def-common.IndexMode",
+ "type": "Type",
+ "tags": [],
+ "label": "IndexMode",
+ "description": [],
+ "signature": [
+ "\"standard\" | \"time_series\" | \"logsdb\""
+ ],
+ "path": "x-pack/plugins/index_management/common/types/data_streams.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
{
"parentPluginId": "indexManagement",
"id": "def-common.INTERNAL_API_BASE_PATH",
diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx
index 9fe9480e16d1c..b02fca3e4caf3 100644
--- a/api_docs/index_management.mdx
+++ b/api_docs/index_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
title: "indexManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexManagement plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kiban
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 241 | 0 | 236 | 1 |
+| 244 | 0 | 239 | 1 |
## Client
diff --git a/api_docs/inference.mdx b/api_docs/inference.mdx
index 49deef8392354..a4151609f299e 100644
--- a/api_docs/inference.mdx
+++ b/api_docs/inference.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inference
title: "inference"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inference plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference']
---
import inferenceObj from './inference.devdocs.json';
diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx
index e6b8be0c9dc59..43fcdd5c3c0e3 100644
--- a/api_docs/infra.mdx
+++ b/api_docs/infra.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra
title: "infra"
image: https://source.unsplash.com/400x175/?github
description: API docs for the infra plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';
diff --git a/api_docs/ingest_pipelines.mdx b/api_docs/ingest_pipelines.mdx
index daf038f442920..a11be6fffdc49 100644
--- a/api_docs/ingest_pipelines.mdx
+++ b/api_docs/ingest_pipelines.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ingestPipelines
title: "ingestPipelines"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ingestPipelines plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines']
---
import ingestPipelinesObj from './ingest_pipelines.devdocs.json';
diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx
index 2faafa3f1120b..d9176041beb7a 100644
--- a/api_docs/inspector.mdx
+++ b/api_docs/inspector.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector
title: "inspector"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inspector plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
---
import inspectorObj from './inspector.devdocs.json';
diff --git a/api_docs/integration_assistant.mdx b/api_docs/integration_assistant.mdx
index 1d38d644f08b2..14d99fc63281f 100644
--- a/api_docs/integration_assistant.mdx
+++ b/api_docs/integration_assistant.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/integrationAssistant
title: "integrationAssistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the integrationAssistant plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'integrationAssistant']
---
import integrationAssistantObj from './integration_assistant.devdocs.json';
diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx
index 4c8f0f836a5d6..e6f6764a356b2 100644
--- a/api_docs/interactive_setup.mdx
+++ b/api_docs/interactive_setup.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
title: "interactiveSetup"
image: https://source.unsplash.com/400x175/?github
description: API docs for the interactiveSetup plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';
diff --git a/api_docs/inventory.mdx b/api_docs/inventory.mdx
index 71b792755cd51..cc4b86185fe18 100644
--- a/api_docs/inventory.mdx
+++ b/api_docs/inventory.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inventory
title: "inventory"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inventory plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inventory']
---
import inventoryObj from './inventory.devdocs.json';
diff --git a/api_docs/investigate.mdx b/api_docs/investigate.mdx
index db3abb3d022e3..a6248ae451710 100644
--- a/api_docs/investigate.mdx
+++ b/api_docs/investigate.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/investigate
title: "investigate"
image: https://source.unsplash.com/400x175/?github
description: API docs for the investigate plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigate']
---
import investigateObj from './investigate.devdocs.json';
diff --git a/api_docs/investigate_app.mdx b/api_docs/investigate_app.mdx
index 487b8025ef047..8de6735114c00 100644
--- a/api_docs/investigate_app.mdx
+++ b/api_docs/investigate_app.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/investigateApp
title: "investigateApp"
image: https://source.unsplash.com/400x175/?github
description: API docs for the investigateApp plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigateApp']
---
import investigateAppObj from './investigate_app.devdocs.json';
diff --git a/api_docs/kbn_actions_types.mdx b/api_docs/kbn_actions_types.mdx
index 6129fbcdc36fc..7211202d5e414 100644
--- a/api_docs/kbn_actions_types.mdx
+++ b/api_docs/kbn_actions_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-actions-types
title: "@kbn/actions-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/actions-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/actions-types']
---
import kbnActionsTypesObj from './kbn_actions_types.devdocs.json';
diff --git a/api_docs/kbn_ai_assistant.devdocs.json b/api_docs/kbn_ai_assistant.devdocs.json
index f80f569dd4300..962d4a3f0e304 100644
--- a/api_docs/kbn_ai_assistant.devdocs.json
+++ b/api_docs/kbn_ai_assistant.devdocs.json
@@ -1099,11 +1099,13 @@
"label": "status",
"description": [],
"signature": [
- "State<{ ready: boolean; enabled: boolean; error?: any; deployment_state?: ",
+ "State<{ errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<",
+ "InferenceInferenceEndpointInfo",
+ "> | undefined; model_stats?: { deployment_state: ",
"MlDeploymentState",
- " | undefined; allocation_state?: ",
+ " | undefined; allocation_state: ",
"MlDeploymentAllocationState",
- " | undefined; model_name?: string | undefined; }> & { refresh: () => void; }"
+ " | undefined; } | undefined; }> & { refresh: () => void; }"
],
"path": "x-pack/packages/kbn-ai-assistant/src/hooks/use_knowledge_base.tsx",
"deprecated": false,
diff --git a/api_docs/kbn_ai_assistant.mdx b/api_docs/kbn_ai_assistant.mdx
index fcc8af4913451..cef8c80d64e32 100644
--- a/api_docs/kbn_ai_assistant.mdx
+++ b/api_docs/kbn_ai_assistant.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ai-assistant
title: "@kbn/ai-assistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ai-assistant plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ai-assistant']
---
import kbnAiAssistantObj from './kbn_ai_assistant.devdocs.json';
diff --git a/api_docs/kbn_ai_assistant_common.mdx b/api_docs/kbn_ai_assistant_common.mdx
index 6e77eea60dc70..7a1061b03294e 100644
--- a/api_docs/kbn_ai_assistant_common.mdx
+++ b/api_docs/kbn_ai_assistant_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ai-assistant-common
title: "@kbn/ai-assistant-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ai-assistant-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ai-assistant-common']
---
import kbnAiAssistantCommonObj from './kbn_ai_assistant_common.devdocs.json';
diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx
index 0715ea8dc9f87..bc762d1a96919 100644
--- a/api_docs/kbn_aiops_components.mdx
+++ b/api_docs/kbn_aiops_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components
title: "@kbn/aiops-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
---
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';
diff --git a/api_docs/kbn_aiops_log_pattern_analysis.mdx b/api_docs/kbn_aiops_log_pattern_analysis.mdx
index 393c712d31ed9..dd8498a8b37af 100644
--- a/api_docs/kbn_aiops_log_pattern_analysis.mdx
+++ b/api_docs/kbn_aiops_log_pattern_analysis.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-pattern-analysis
title: "@kbn/aiops-log-pattern-analysis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-log-pattern-analysis plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-pattern-analysis']
---
import kbnAiopsLogPatternAnalysisObj from './kbn_aiops_log_pattern_analysis.devdocs.json';
diff --git a/api_docs/kbn_aiops_log_rate_analysis.mdx b/api_docs/kbn_aiops_log_rate_analysis.mdx
index 7b05ff688771f..7ed9264f3f0b7 100644
--- a/api_docs/kbn_aiops_log_rate_analysis.mdx
+++ b/api_docs/kbn_aiops_log_rate_analysis.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-rate-analysis
title: "@kbn/aiops-log-rate-analysis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-log-rate-analysis plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-rate-analysis']
---
import kbnAiopsLogRateAnalysisObj from './kbn_aiops_log_rate_analysis.devdocs.json';
diff --git a/api_docs/kbn_alerting_api_integration_helpers.mdx b/api_docs/kbn_alerting_api_integration_helpers.mdx
index 7f47c6038a43b..3ce053f404602 100644
--- a/api_docs/kbn_alerting_api_integration_helpers.mdx
+++ b/api_docs/kbn_alerting_api_integration_helpers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-api-integration-helpers
title: "@kbn/alerting-api-integration-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-api-integration-helpers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-api-integration-helpers']
---
import kbnAlertingApiIntegrationHelpersObj from './kbn_alerting_api_integration_helpers.devdocs.json';
diff --git a/api_docs/kbn_alerting_comparators.mdx b/api_docs/kbn_alerting_comparators.mdx
index b70aa1b545232..9513f4a553c82 100644
--- a/api_docs/kbn_alerting_comparators.mdx
+++ b/api_docs/kbn_alerting_comparators.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-comparators
title: "@kbn/alerting-comparators"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-comparators plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-comparators']
---
import kbnAlertingComparatorsObj from './kbn_alerting_comparators.devdocs.json';
diff --git a/api_docs/kbn_alerting_state_types.mdx b/api_docs/kbn_alerting_state_types.mdx
index 03a0a768c29ba..21ca6c4333503 100644
--- a/api_docs/kbn_alerting_state_types.mdx
+++ b/api_docs/kbn_alerting_state_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types
title: "@kbn/alerting-state-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-state-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
---
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';
diff --git a/api_docs/kbn_alerting_types.mdx b/api_docs/kbn_alerting_types.mdx
index 5c6b10788856c..a9810fbc7370a 100644
--- a/api_docs/kbn_alerting_types.mdx
+++ b/api_docs/kbn_alerting_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-types
title: "@kbn/alerting-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-types']
---
import kbnAlertingTypesObj from './kbn_alerting_types.devdocs.json';
diff --git a/api_docs/kbn_alerts_as_data_utils.mdx b/api_docs/kbn_alerts_as_data_utils.mdx
index a89f8ee34b4f3..492db1820cbd2 100644
--- a/api_docs/kbn_alerts_as_data_utils.mdx
+++ b/api_docs/kbn_alerts_as_data_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils
title: "@kbn/alerts-as-data-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-as-data-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
---
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';
diff --git a/api_docs/kbn_alerts_grouping.mdx b/api_docs/kbn_alerts_grouping.mdx
index 865ab457030c7..c02e400c48bee 100644
--- a/api_docs/kbn_alerts_grouping.mdx
+++ b/api_docs/kbn_alerts_grouping.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-grouping
title: "@kbn/alerts-grouping"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-grouping plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-grouping']
---
import kbnAlertsGroupingObj from './kbn_alerts_grouping.devdocs.json';
diff --git a/api_docs/kbn_alerts_ui_shared.mdx b/api_docs/kbn_alerts_ui_shared.mdx
index 6cd51bcfe3323..3536eb23c7828 100644
--- a/api_docs/kbn_alerts_ui_shared.mdx
+++ b/api_docs/kbn_alerts_ui_shared.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared
title: "@kbn/alerts-ui-shared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-ui-shared plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
---
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json';
diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx
index ca7eb747e028c..2b338d76c63bb 100644
--- a/api_docs/kbn_analytics.mdx
+++ b/api_docs/kbn_analytics.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
title: "@kbn/analytics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
---
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';
diff --git a/api_docs/kbn_analytics_collection_utils.mdx b/api_docs/kbn_analytics_collection_utils.mdx
index 6ffe39a20b8e8..668006e7a3156 100644
--- a/api_docs/kbn_analytics_collection_utils.mdx
+++ b/api_docs/kbn_analytics_collection_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-collection-utils
title: "@kbn/analytics-collection-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-collection-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-collection-utils']
---
import kbnAnalyticsCollectionUtilsObj from './kbn_analytics_collection_utils.devdocs.json';
diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx
index 9d098b7455cac..47462e78cae6a 100644
--- a/api_docs/kbn_apm_config_loader.mdx
+++ b/api_docs/kbn_apm_config_loader.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader
title: "@kbn/apm-config-loader"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-config-loader plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
---
import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json';
diff --git a/api_docs/kbn_apm_data_view.mdx b/api_docs/kbn_apm_data_view.mdx
index 0c1c7502aeb9c..b95e219a264ab 100644
--- a/api_docs/kbn_apm_data_view.mdx
+++ b/api_docs/kbn_apm_data_view.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-data-view
title: "@kbn/apm-data-view"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-data-view plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-data-view']
---
import kbnApmDataViewObj from './kbn_apm_data_view.devdocs.json';
diff --git a/api_docs/kbn_apm_synthtrace.mdx b/api_docs/kbn_apm_synthtrace.mdx
index 8d62591b7f754..e480fab6ec314 100644
--- a/api_docs/kbn_apm_synthtrace.mdx
+++ b/api_docs/kbn_apm_synthtrace.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace
title: "@kbn/apm-synthtrace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-synthtrace plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace']
---
import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json';
diff --git a/api_docs/kbn_apm_synthtrace_client.mdx b/api_docs/kbn_apm_synthtrace_client.mdx
index d55f23b414a5f..b33bd63fbc954 100644
--- a/api_docs/kbn_apm_synthtrace_client.mdx
+++ b/api_docs/kbn_apm_synthtrace_client.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace-client
title: "@kbn/apm-synthtrace-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-synthtrace-client plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace-client']
---
import kbnApmSynthtraceClientObj from './kbn_apm_synthtrace_client.devdocs.json';
diff --git a/api_docs/kbn_apm_types.mdx b/api_docs/kbn_apm_types.mdx
index 080a261c76283..e68a5a9f47030 100644
--- a/api_docs/kbn_apm_types.mdx
+++ b/api_docs/kbn_apm_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-types
title: "@kbn/apm-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-types']
---
import kbnApmTypesObj from './kbn_apm_types.devdocs.json';
diff --git a/api_docs/kbn_apm_utils.devdocs.json b/api_docs/kbn_apm_utils.devdocs.json
index a2f6a020ccaba..56a7f3581459d 100644
--- a/api_docs/kbn_apm_utils.devdocs.json
+++ b/api_docs/kbn_apm_utils.devdocs.json
@@ -92,7 +92,9 @@
},
", cb: (span?: ",
"Span",
- " | undefined) => Promise) => Promise"
+ " | undefined) => Promise, logger: ",
+ "Logger",
+ " | undefined) => Promise"
],
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false,
@@ -136,6 +138,22 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
+ },
+ {
+ "parentPluginId": "@kbn/apm-utils",
+ "id": "def-common.withSpan.$3",
+ "type": "Object",
+ "tags": [],
+ "label": "logger",
+ "description": [],
+ "signature": [
+ "Logger",
+ " | undefined"
+ ],
+ "path": "packages/kbn-apm-utils/index.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": false
}
],
"returnComment": [],
diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx
index ec9bffb26dc86..c77bb3263d999 100644
--- a/api_docs/kbn_apm_utils.mdx
+++ b/api_docs/kbn_apm_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils
title: "@kbn/apm-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils']
---
import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/te
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 11 | 0 | 11 | 0 |
+| 12 | 0 | 12 | 0 |
## Common
diff --git a/api_docs/kbn_avc_banner.mdx b/api_docs/kbn_avc_banner.mdx
index cad2eb3f093b1..240ee99bfae64 100644
--- a/api_docs/kbn_avc_banner.mdx
+++ b/api_docs/kbn_avc_banner.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-avc-banner
title: "@kbn/avc-banner"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/avc-banner plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/avc-banner']
---
import kbnAvcBannerObj from './kbn_avc_banner.devdocs.json';
diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx
index b63f2db8b82c0..766de80d968cc 100644
--- a/api_docs/kbn_axe_config.mdx
+++ b/api_docs/kbn_axe_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config
title: "@kbn/axe-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/axe-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config']
---
import kbnAxeConfigObj from './kbn_axe_config.devdocs.json';
diff --git a/api_docs/kbn_bfetch_error.mdx b/api_docs/kbn_bfetch_error.mdx
index e7ba0d4b7e1ea..666bb7cc6f6f3 100644
--- a/api_docs/kbn_bfetch_error.mdx
+++ b/api_docs/kbn_bfetch_error.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-bfetch-error
title: "@kbn/bfetch-error"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/bfetch-error plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bfetch-error']
---
import kbnBfetchErrorObj from './kbn_bfetch_error.devdocs.json';
diff --git a/api_docs/kbn_calculate_auto.mdx b/api_docs/kbn_calculate_auto.mdx
index 31470280e5840..1262ce7b9365a 100644
--- a/api_docs/kbn_calculate_auto.mdx
+++ b/api_docs/kbn_calculate_auto.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-calculate-auto
title: "@kbn/calculate-auto"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/calculate-auto plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/calculate-auto']
---
import kbnCalculateAutoObj from './kbn_calculate_auto.devdocs.json';
diff --git a/api_docs/kbn_calculate_width_from_char_count.mdx b/api_docs/kbn_calculate_width_from_char_count.mdx
index c8c13a00b717a..fa48f8bae4d6f 100644
--- a/api_docs/kbn_calculate_width_from_char_count.mdx
+++ b/api_docs/kbn_calculate_width_from_char_count.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-calculate-width-from-char-count
title: "@kbn/calculate-width-from-char-count"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/calculate-width-from-char-count plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/calculate-width-from-char-count']
---
import kbnCalculateWidthFromCharCountObj from './kbn_calculate_width_from_char_count.devdocs.json';
diff --git a/api_docs/kbn_cases_components.mdx b/api_docs/kbn_cases_components.mdx
index eb15cdf9f2993..3d2757d7c533a 100644
--- a/api_docs/kbn_cases_components.mdx
+++ b/api_docs/kbn_cases_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cases-components
title: "@kbn/cases-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cases-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cases-components']
---
import kbnCasesComponentsObj from './kbn_cases_components.devdocs.json';
diff --git a/api_docs/kbn_cbor.mdx b/api_docs/kbn_cbor.mdx
index 771a807cb8cc7..5a330ce6bf31c 100644
--- a/api_docs/kbn_cbor.mdx
+++ b/api_docs/kbn_cbor.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cbor
title: "@kbn/cbor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cbor plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cbor']
---
import kbnCborObj from './kbn_cbor.devdocs.json';
diff --git a/api_docs/kbn_cell_actions.mdx b/api_docs/kbn_cell_actions.mdx
index 152ef8083e302..ba0de8e88b091 100644
--- a/api_docs/kbn_cell_actions.mdx
+++ b/api_docs/kbn_cell_actions.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cell-actions
title: "@kbn/cell-actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cell-actions plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cell-actions']
---
import kbnCellActionsObj from './kbn_cell_actions.devdocs.json';
diff --git a/api_docs/kbn_chart_expressions_common.mdx b/api_docs/kbn_chart_expressions_common.mdx
index eebe4645922cc..44a34c0062638 100644
--- a/api_docs/kbn_chart_expressions_common.mdx
+++ b/api_docs/kbn_chart_expressions_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-expressions-common
title: "@kbn/chart-expressions-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/chart-expressions-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-expressions-common']
---
import kbnChartExpressionsCommonObj from './kbn_chart_expressions_common.devdocs.json';
diff --git a/api_docs/kbn_chart_icons.mdx b/api_docs/kbn_chart_icons.mdx
index 885a76df7cbbd..b323db375b3d8 100644
--- a/api_docs/kbn_chart_icons.mdx
+++ b/api_docs/kbn_chart_icons.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons
title: "@kbn/chart-icons"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/chart-icons plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-icons']
---
import kbnChartIconsObj from './kbn_chart_icons.devdocs.json';
diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx
index 1c0689e6a994d..848283f921b12 100644
--- a/api_docs/kbn_ci_stats_core.mdx
+++ b/api_docs/kbn_ci_stats_core.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core
title: "@kbn/ci-stats-core"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ci-stats-core plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core']
---
import kbnCiStatsCoreObj from './kbn_ci_stats_core.devdocs.json';
diff --git a/api_docs/kbn_ci_stats_performance_metrics.mdx b/api_docs/kbn_ci_stats_performance_metrics.mdx
index 8a4a079970d16..27567347f997e 100644
--- a/api_docs/kbn_ci_stats_performance_metrics.mdx
+++ b/api_docs/kbn_ci_stats_performance_metrics.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics
title: "@kbn/ci-stats-performance-metrics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ci-stats-performance-metrics plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics']
---
import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json';
diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx
index b5fe19396bdf8..f5b4db096c4de 100644
--- a/api_docs/kbn_ci_stats_reporter.mdx
+++ b/api_docs/kbn_ci_stats_reporter.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter
title: "@kbn/ci-stats-reporter"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ci-stats-reporter plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter']
---
import kbnCiStatsReporterObj from './kbn_ci_stats_reporter.devdocs.json';
diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx
index e18eeb01636f7..48bdfa24cb82f 100644
--- a/api_docs/kbn_cli_dev_mode.mdx
+++ b/api_docs/kbn_cli_dev_mode.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode
title: "@kbn/cli-dev-mode"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cli-dev-mode plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode']
---
import kbnCliDevModeObj from './kbn_cli_dev_mode.devdocs.json';
diff --git a/api_docs/kbn_cloud_security_posture.mdx b/api_docs/kbn_cloud_security_posture.mdx
index d88a3b3d0862e..cd017d402dbb3 100644
--- a/api_docs/kbn_cloud_security_posture.mdx
+++ b/api_docs/kbn_cloud_security_posture.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cloud-security-posture
title: "@kbn/cloud-security-posture"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cloud-security-posture plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cloud-security-posture']
---
import kbnCloudSecurityPostureObj from './kbn_cloud_security_posture.devdocs.json';
diff --git a/api_docs/kbn_cloud_security_posture_common.mdx b/api_docs/kbn_cloud_security_posture_common.mdx
index 6683d098c0a37..f736c020ccc34 100644
--- a/api_docs/kbn_cloud_security_posture_common.mdx
+++ b/api_docs/kbn_cloud_security_posture_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cloud-security-posture-common
title: "@kbn/cloud-security-posture-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cloud-security-posture-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cloud-security-posture-common']
---
import kbnCloudSecurityPostureCommonObj from './kbn_cloud_security_posture_common.devdocs.json';
diff --git a/api_docs/kbn_cloud_security_posture_graph.mdx b/api_docs/kbn_cloud_security_posture_graph.mdx
index 1565a5e6ce953..61b89ff227ab5 100644
--- a/api_docs/kbn_cloud_security_posture_graph.mdx
+++ b/api_docs/kbn_cloud_security_posture_graph.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cloud-security-posture-graph
title: "@kbn/cloud-security-posture-graph"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cloud-security-posture-graph plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cloud-security-posture-graph']
---
import kbnCloudSecurityPostureGraphObj from './kbn_cloud_security_posture_graph.devdocs.json';
diff --git a/api_docs/kbn_code_editor.mdx b/api_docs/kbn_code_editor.mdx
index 7cb981b2b27e1..3d59b249d8138 100644
--- a/api_docs/kbn_code_editor.mdx
+++ b/api_docs/kbn_code_editor.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor
title: "@kbn/code-editor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/code-editor plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor']
---
import kbnCodeEditorObj from './kbn_code_editor.devdocs.json';
diff --git a/api_docs/kbn_code_editor_mock.mdx b/api_docs/kbn_code_editor_mock.mdx
index 8952a7230ea30..98efccc631fe7 100644
--- a/api_docs/kbn_code_editor_mock.mdx
+++ b/api_docs/kbn_code_editor_mock.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor-mock
title: "@kbn/code-editor-mock"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/code-editor-mock plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor-mock']
---
import kbnCodeEditorMockObj from './kbn_code_editor_mock.devdocs.json';
diff --git a/api_docs/kbn_code_owners.mdx b/api_docs/kbn_code_owners.mdx
index dedadcc3b5881..cc27d36435a8b 100644
--- a/api_docs/kbn_code_owners.mdx
+++ b/api_docs/kbn_code_owners.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-owners
title: "@kbn/code-owners"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/code-owners plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-owners']
---
import kbnCodeOwnersObj from './kbn_code_owners.devdocs.json';
diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx
index e2ee0de6be728..9a4385430be10 100644
--- a/api_docs/kbn_coloring.mdx
+++ b/api_docs/kbn_coloring.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-coloring
title: "@kbn/coloring"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/coloring plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring']
---
import kbnColoringObj from './kbn_coloring.devdocs.json';
diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx
index 1db49be81f812..4fd25c7b51c10 100644
--- a/api_docs/kbn_config.mdx
+++ b/api_docs/kbn_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config
title: "@kbn/config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config']
---
import kbnConfigObj from './kbn_config.devdocs.json';
diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx
index bb089a9552654..a408b815ec858 100644
--- a/api_docs/kbn_config_mocks.mdx
+++ b/api_docs/kbn_config_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks
title: "@kbn/config-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/config-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks']
---
import kbnConfigMocksObj from './kbn_config_mocks.devdocs.json';
diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx
index c716a6e763e5a..23f194af624f0 100644
--- a/api_docs/kbn_config_schema.mdx
+++ b/api_docs/kbn_config_schema.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema
title: "@kbn/config-schema"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/config-schema plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema']
---
import kbnConfigSchemaObj from './kbn_config_schema.devdocs.json';
diff --git a/api_docs/kbn_content_management_content_editor.mdx b/api_docs/kbn_content_management_content_editor.mdx
index 6ff8a73b0343b..57c9577c46d38 100644
--- a/api_docs/kbn_content_management_content_editor.mdx
+++ b/api_docs/kbn_content_management_content_editor.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-content-editor
title: "@kbn/content-management-content-editor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-content-editor plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-content-editor']
---
import kbnContentManagementContentEditorObj from './kbn_content_management_content_editor.devdocs.json';
diff --git a/api_docs/kbn_content_management_content_insights_public.mdx b/api_docs/kbn_content_management_content_insights_public.mdx
index 76e38460ea059..89eb750caa396 100644
--- a/api_docs/kbn_content_management_content_insights_public.mdx
+++ b/api_docs/kbn_content_management_content_insights_public.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-content-insights-public
title: "@kbn/content-management-content-insights-public"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-content-insights-public plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-content-insights-public']
---
import kbnContentManagementContentInsightsPublicObj from './kbn_content_management_content_insights_public.devdocs.json';
diff --git a/api_docs/kbn_content_management_content_insights_server.mdx b/api_docs/kbn_content_management_content_insights_server.mdx
index e38f29dee3593..43fd55100ed05 100644
--- a/api_docs/kbn_content_management_content_insights_server.mdx
+++ b/api_docs/kbn_content_management_content_insights_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-content-insights-server
title: "@kbn/content-management-content-insights-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-content-insights-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-content-insights-server']
---
import kbnContentManagementContentInsightsServerObj from './kbn_content_management_content_insights_server.devdocs.json';
diff --git a/api_docs/kbn_content_management_favorites_common.devdocs.json b/api_docs/kbn_content_management_favorites_common.devdocs.json
new file mode 100644
index 0000000000000..5db569f43100b
--- /dev/null
+++ b/api_docs/kbn_content_management_favorites_common.devdocs.json
@@ -0,0 +1,43 @@
+{
+ "id": "@kbn/content-management-favorites-common",
+ "client": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "server": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "common": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [
+ {
+ "parentPluginId": "@kbn/content-management-favorites-common",
+ "id": "def-common.FAVORITES_LIMIT",
+ "type": "number",
+ "tags": [],
+ "label": "FAVORITES_LIMIT",
+ "description": [],
+ "signature": [
+ "100"
+ ],
+ "path": "packages/content-management/favorites/favorites_common/index.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ }
+ ],
+ "objects": []
+ }
+}
\ No newline at end of file
diff --git a/api_docs/kbn_content_management_favorites_common.mdx b/api_docs/kbn_content_management_favorites_common.mdx
new file mode 100644
index 0000000000000..c647ff4e9af0a
--- /dev/null
+++ b/api_docs/kbn_content_management_favorites_common.mdx
@@ -0,0 +1,30 @@
+---
+####
+#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
+#### Reach out in #docs-engineering for more info.
+####
+id: kibKbnContentManagementFavoritesCommonPluginApi
+slug: /kibana-dev-docs/api/kbn-content-management-favorites-common
+title: "@kbn/content-management-favorites-common"
+image: https://source.unsplash.com/400x175/?github
+description: API docs for the @kbn/content-management-favorites-common plugin
+date: 2024-11-19
+tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-favorites-common']
+---
+import kbnContentManagementFavoritesCommonObj from './kbn_content_management_favorites_common.devdocs.json';
+
+
+
+Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) for questions regarding this plugin.
+
+**Code health stats**
+
+| Public API count | Any count | Items lacking comments | Missing exports |
+|-------------------|-----------|------------------------|-----------------|
+| 1 | 0 | 1 | 0 |
+
+## Common
+
+### Consts, variables and types
+
+
diff --git a/api_docs/kbn_content_management_favorites_public.devdocs.json b/api_docs/kbn_content_management_favorites_public.devdocs.json
index e4efbf68df82e..f9c7973e3f746 100644
--- a/api_docs/kbn_content_management_favorites_public.devdocs.json
+++ b/api_docs/kbn_content_management_favorites_public.devdocs.json
@@ -17,14 +17,15 @@
"section": "def-public.FavoritesClient",
"text": "FavoritesClient"
},
- " implements ",
+ " implements ",
{
"pluginId": "@kbn/content-management-favorites-public",
"scope": "public",
"docId": "kibKbnContentManagementFavoritesPublicPluginApi",
"section": "def-public.FavoritesClientPublic",
"text": "FavoritesClientPublic"
- }
+ },
+ ""
],
"path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
"deprecated": false,
@@ -140,14 +141,8 @@
"description": [],
"signature": [
"() => Promise<",
- {
- "pluginId": "@kbn/content-management-favorites-server",
- "scope": "server",
- "docId": "kibKbnContentManagementFavoritesServerPluginApi",
- "section": "def-server.GetFavoritesResponse",
- "text": "GetFavoritesResponse"
- },
- ">"
+ "GetFavoritesResponse",
+ ">"
],
"path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
"deprecated": false,
@@ -163,13 +158,13 @@
"label": "addFavorite",
"description": [],
"signature": [
- "({ id }: { id: string; }) => Promise<",
+ "(params: AddFavoriteRequest) => Promise<",
{
"pluginId": "@kbn/content-management-favorites-server",
"scope": "server",
"docId": "kibKbnContentManagementFavoritesServerPluginApi",
- "section": "def-server.GetFavoritesResponse",
- "text": "GetFavoritesResponse"
+ "section": "def-server.AddFavoriteResponse",
+ "text": "AddFavoriteResponse"
},
">"
],
@@ -180,26 +175,17 @@
{
"parentPluginId": "@kbn/content-management-favorites-public",
"id": "def-public.FavoritesClient.addFavorite.$1",
- "type": "Object",
+ "type": "Uncategorized",
"tags": [],
- "label": "{ id }",
+ "label": "params",
"description": [],
+ "signature": [
+ "AddFavoriteRequest"
+ ],
"path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
"deprecated": false,
"trackAdoption": false,
- "children": [
- {
- "parentPluginId": "@kbn/content-management-favorites-public",
- "id": "def-public.FavoritesClient.addFavorite.$1.id",
- "type": "string",
- "tags": [],
- "label": "id",
- "description": [],
- "path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
- "deprecated": false,
- "trackAdoption": false
- }
- ]
+ "isRequired": true
}
],
"returnComment": []
@@ -217,8 +203,8 @@
"pluginId": "@kbn/content-management-favorites-server",
"scope": "server",
"docId": "kibKbnContentManagementFavoritesServerPluginApi",
- "section": "def-server.GetFavoritesResponse",
- "text": "GetFavoritesResponse"
+ "section": "def-server.RemoveFavoriteResponse",
+ "text": "RemoveFavoriteResponse"
},
">"
],
@@ -509,14 +495,8 @@
"({ enabled }?: { enabled?: boolean | undefined; }) => ",
"UseQueryResult",
"<",
- {
- "pluginId": "@kbn/content-management-favorites-server",
- "scope": "server",
- "docId": "kibKbnContentManagementFavoritesServerPluginApi",
- "section": "def-server.GetFavoritesResponse",
- "text": "GetFavoritesResponse"
- },
- ", unknown>"
+ "GetFavoritesResponse",
+ ", unknown>"
],
"path": "packages/content-management/favorites/favorites_public/src/favorites_query.tsx",
"deprecated": false,
@@ -601,6 +581,16 @@
"tags": [],
"label": "FavoritesClientPublic",
"description": [],
+ "signature": [
+ {
+ "pluginId": "@kbn/content-management-favorites-public",
+ "scope": "public",
+ "docId": "kibKbnContentManagementFavoritesPublicPluginApi",
+ "section": "def-public.FavoritesClientPublic",
+ "text": "FavoritesClientPublic"
+ },
+ ""
+ ],
"path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
"deprecated": false,
"trackAdoption": false,
@@ -614,14 +604,8 @@
"description": [],
"signature": [
"() => Promise<",
- {
- "pluginId": "@kbn/content-management-favorites-server",
- "scope": "server",
- "docId": "kibKbnContentManagementFavoritesServerPluginApi",
- "section": "def-server.GetFavoritesResponse",
- "text": "GetFavoritesResponse"
- },
- ">"
+ "GetFavoritesResponse",
+ ">"
],
"path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
"deprecated": false,
@@ -637,13 +621,13 @@
"label": "addFavorite",
"description": [],
"signature": [
- "({ id }: { id: string; }) => Promise<",
+ "(params: AddFavoriteRequest) => Promise<",
{
"pluginId": "@kbn/content-management-favorites-server",
"scope": "server",
"docId": "kibKbnContentManagementFavoritesServerPluginApi",
- "section": "def-server.GetFavoritesResponse",
- "text": "GetFavoritesResponse"
+ "section": "def-server.AddFavoriteResponse",
+ "text": "AddFavoriteResponse"
},
">"
],
@@ -654,26 +638,17 @@
{
"parentPluginId": "@kbn/content-management-favorites-public",
"id": "def-public.FavoritesClientPublic.addFavorite.$1",
- "type": "Object",
+ "type": "Uncategorized",
"tags": [],
- "label": "{ id }",
+ "label": "params",
"description": [],
+ "signature": [
+ "AddFavoriteRequest"
+ ],
"path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
"deprecated": false,
"trackAdoption": false,
- "children": [
- {
- "parentPluginId": "@kbn/content-management-favorites-public",
- "id": "def-public.FavoritesClientPublic.addFavorite.$1.id",
- "type": "string",
- "tags": [],
- "label": "id",
- "description": [],
- "path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
- "deprecated": false,
- "trackAdoption": false
- }
- ]
+ "isRequired": true
}
],
"returnComment": []
@@ -686,13 +661,13 @@
"label": "removeFavorite",
"description": [],
"signature": [
- "({ id }: { id: string; }) => Promise<",
+ "(params: { id: string; }) => Promise<",
{
"pluginId": "@kbn/content-management-favorites-server",
"scope": "server",
"docId": "kibKbnContentManagementFavoritesServerPluginApi",
- "section": "def-server.GetFavoritesResponse",
- "text": "GetFavoritesResponse"
+ "section": "def-server.RemoveFavoriteResponse",
+ "text": "RemoveFavoriteResponse"
},
">"
],
@@ -705,7 +680,7 @@
"id": "def-public.FavoritesClientPublic.removeFavorite.$1",
"type": "Object",
"tags": [],
- "label": "{ id }",
+ "label": "params",
"description": [],
"path": "packages/content-management/favorites/favorites_public/src/favorites_client.ts",
"deprecated": false,
diff --git a/api_docs/kbn_content_management_favorites_public.mdx b/api_docs/kbn_content_management_favorites_public.mdx
index 00f1eb5e1acbe..1080358ce4ad3 100644
--- a/api_docs/kbn_content_management_favorites_public.mdx
+++ b/api_docs/kbn_content_management_favorites_public.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-favorites-public
title: "@kbn/content-management-favorites-public"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-favorites-public plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-favorites-public']
---
import kbnContentManagementFavoritesPublicObj from './kbn_content_management_favorites_public.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 45 | 0 | 44 | 0 |
+| 43 | 0 | 42 | 1 |
## Client
diff --git a/api_docs/kbn_content_management_favorites_server.devdocs.json b/api_docs/kbn_content_management_favorites_server.devdocs.json
index 333a8d280971a..9d76ed71bef3a 100644
--- a/api_docs/kbn_content_management_favorites_server.devdocs.json
+++ b/api_docs/kbn_content_management_favorites_server.devdocs.json
@@ -43,7 +43,8 @@
"section": "def-server.UsageCollectionSetup",
"text": "UsageCollectionSetup"
},
- " | undefined; }) => void"
+ " | undefined; }) => ",
+ "FavoritesRegistrySetup"
],
"path": "packages/content-management/favorites/favorites_server/src/index.ts",
"deprecated": false,
@@ -130,6 +131,34 @@
}
],
"interfaces": [
+ {
+ "parentPluginId": "@kbn/content-management-favorites-server",
+ "id": "def-server.AddFavoriteResponse",
+ "type": "Interface",
+ "tags": [],
+ "label": "AddFavoriteResponse",
+ "description": [],
+ "path": "packages/content-management/favorites/favorites_server/src/favorites_routes.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/content-management-favorites-server",
+ "id": "def-server.AddFavoriteResponse.favoriteIds",
+ "type": "Array",
+ "tags": [],
+ "label": "favoriteIds",
+ "description": [],
+ "signature": [
+ "string[]"
+ ],
+ "path": "packages/content-management/favorites/favorites_server/src/favorites_routes.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/content-management-favorites-server",
"id": "def-server.GetFavoritesResponse",
@@ -154,13 +183,71 @@
"path": "packages/content-management/favorites/favorites_server/src/favorites_routes.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/content-management-favorites-server",
+ "id": "def-server.GetFavoritesResponse.favoriteMetadata",
+ "type": "Object",
+ "tags": [],
+ "label": "favoriteMetadata",
+ "description": [],
+ "signature": [
+ "Record | undefined"
+ ],
+ "path": "packages/content-management/favorites/favorites_server/src/favorites_routes.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/content-management-favorites-server",
+ "id": "def-server.RemoveFavoriteResponse",
+ "type": "Interface",
+ "tags": [],
+ "label": "RemoveFavoriteResponse",
+ "description": [],
+ "path": "packages/content-management/favorites/favorites_server/src/favorites_routes.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/content-management-favorites-server",
+ "id": "def-server.RemoveFavoriteResponse.favoriteIds",
+ "type": "Array",
+ "tags": [],
+ "label": "favoriteIds",
+ "description": [],
+ "signature": [
+ "string[]"
+ ],
+ "path": "packages/content-management/favorites/favorites_server/src/favorites_routes.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
- "misc": [],
+ "misc": [
+ {
+ "parentPluginId": "@kbn/content-management-favorites-server",
+ "id": "def-server.FavoritesSetup",
+ "type": "Type",
+ "tags": [],
+ "label": "FavoritesSetup",
+ "description": [],
+ "signature": [
+ "{ registerFavoriteType: (type: string, config?: FavoriteTypeConfig) => void; }"
+ ],
+ "path": "packages/content-management/favorites/favorites_server/src/index.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ }
+ ],
"objects": []
},
"common": {
diff --git a/api_docs/kbn_content_management_favorites_server.mdx b/api_docs/kbn_content_management_favorites_server.mdx
index 63ec28ecd559f..a86dfef8351a2 100644
--- a/api_docs/kbn_content_management_favorites_server.mdx
+++ b/api_docs/kbn_content_management_favorites_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-favorites-server
title: "@kbn/content-management-favorites-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-favorites-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-favorites-server']
---
import kbnContentManagementFavoritesServerObj from './kbn_content_management_favorites_server.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 7 | 0 | 7 | 0 |
+| 13 | 0 | 13 | 1 |
## Server
@@ -31,3 +31,6 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
### Interfaces
+### Consts, variables and types
+
+
diff --git a/api_docs/kbn_content_management_tabbed_table_list_view.mdx b/api_docs/kbn_content_management_tabbed_table_list_view.mdx
index d0d91f5fe9516..432971b2baa45 100644
--- a/api_docs/kbn_content_management_tabbed_table_list_view.mdx
+++ b/api_docs/kbn_content_management_tabbed_table_list_view.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-tabbed-table-list-view
title: "@kbn/content-management-tabbed-table-list-view"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-tabbed-table-list-view plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-tabbed-table-list-view']
---
import kbnContentManagementTabbedTableListViewObj from './kbn_content_management_tabbed_table_list_view.devdocs.json';
diff --git a/api_docs/kbn_content_management_table_list_view.mdx b/api_docs/kbn_content_management_table_list_view.mdx
index 160a53a28d1c1..666a3526ecaa4 100644
--- a/api_docs/kbn_content_management_table_list_view.mdx
+++ b/api_docs/kbn_content_management_table_list_view.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list-view
title: "@kbn/content-management-table-list-view"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-table-list-view plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list-view']
---
import kbnContentManagementTableListViewObj from './kbn_content_management_table_list_view.devdocs.json';
diff --git a/api_docs/kbn_content_management_table_list_view_common.mdx b/api_docs/kbn_content_management_table_list_view_common.mdx
index ff3cd67f2b774..3fc4386bebc9d 100644
--- a/api_docs/kbn_content_management_table_list_view_common.mdx
+++ b/api_docs/kbn_content_management_table_list_view_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list-view-common
title: "@kbn/content-management-table-list-view-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-table-list-view-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list-view-common']
---
import kbnContentManagementTableListViewCommonObj from './kbn_content_management_table_list_view_common.devdocs.json';
diff --git a/api_docs/kbn_content_management_table_list_view_table.devdocs.json b/api_docs/kbn_content_management_table_list_view_table.devdocs.json
index 7e9c12541d758..21b06f453b89c 100644
--- a/api_docs/kbn_content_management_table_list_view_table.devdocs.json
+++ b/api_docs/kbn_content_management_table_list_view_table.devdocs.json
@@ -343,7 +343,7 @@
"section": "def-public.FavoritesClientPublic",
"text": "FavoritesClientPublic"
},
- " | undefined"
+ " | undefined"
],
"path": "packages/content-management/table_list_view_table/src/services.tsx",
"deprecated": false,
diff --git a/api_docs/kbn_content_management_table_list_view_table.mdx b/api_docs/kbn_content_management_table_list_view_table.mdx
index 4b41567b1b024..08e028c1d08ad 100644
--- a/api_docs/kbn_content_management_table_list_view_table.mdx
+++ b/api_docs/kbn_content_management_table_list_view_table.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list-view-table
title: "@kbn/content-management-table-list-view-table"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-table-list-view-table plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list-view-table']
---
import kbnContentManagementTableListViewTableObj from './kbn_content_management_table_list_view_table.devdocs.json';
diff --git a/api_docs/kbn_content_management_user_profiles.mdx b/api_docs/kbn_content_management_user_profiles.mdx
index 802fe0d5d0180..e476b6f205973 100644
--- a/api_docs/kbn_content_management_user_profiles.mdx
+++ b/api_docs/kbn_content_management_user_profiles.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-user-profiles
title: "@kbn/content-management-user-profiles"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-user-profiles plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-user-profiles']
---
import kbnContentManagementUserProfilesObj from './kbn_content_management_user_profiles.devdocs.json';
diff --git a/api_docs/kbn_content_management_utils.mdx b/api_docs/kbn_content_management_utils.mdx
index 38d1ab5c2db3f..fb289f54c34bd 100644
--- a/api_docs/kbn_content_management_utils.mdx
+++ b/api_docs/kbn_content_management_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-utils
title: "@kbn/content-management-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/content-management-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-utils']
---
import kbnContentManagementUtilsObj from './kbn_content_management_utils.devdocs.json';
diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx
index dcbf80824e200..0238ba23a7f7b 100644
--- a/api_docs/kbn_core_analytics_browser.mdx
+++ b/api_docs/kbn_core_analytics_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser
title: "@kbn/core-analytics-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-analytics-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser']
---
import kbnCoreAnalyticsBrowserObj from './kbn_core_analytics_browser.devdocs.json';
diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx
index 1803d81fd9fd9..800fe438a79f6 100644
--- a/api_docs/kbn_core_analytics_browser_internal.mdx
+++ b/api_docs/kbn_core_analytics_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal
title: "@kbn/core-analytics-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-analytics-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal']
---
import kbnCoreAnalyticsBrowserInternalObj from './kbn_core_analytics_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx
index 588e5c023e627..788bb745d90b4 100644
--- a/api_docs/kbn_core_analytics_browser_mocks.mdx
+++ b/api_docs/kbn_core_analytics_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks
title: "@kbn/core-analytics-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-analytics-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks']
---
import kbnCoreAnalyticsBrowserMocksObj from './kbn_core_analytics_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_analytics_server.mdx b/api_docs/kbn_core_analytics_server.mdx
index 0ac2a41cf4849..2b9c75ed2bf3d 100644
--- a/api_docs/kbn_core_analytics_server.mdx
+++ b/api_docs/kbn_core_analytics_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server
title: "@kbn/core-analytics-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-analytics-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server']
---
import kbnCoreAnalyticsServerObj from './kbn_core_analytics_server.devdocs.json';
diff --git a/api_docs/kbn_core_analytics_server_internal.mdx b/api_docs/kbn_core_analytics_server_internal.mdx
index f049cffcbdce6..6f7fffcdfa216 100644
--- a/api_docs/kbn_core_analytics_server_internal.mdx
+++ b/api_docs/kbn_core_analytics_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal
title: "@kbn/core-analytics-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-analytics-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal']
---
import kbnCoreAnalyticsServerInternalObj from './kbn_core_analytics_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_analytics_server_mocks.mdx b/api_docs/kbn_core_analytics_server_mocks.mdx
index 955be5c250254..c7c22ef1fc9ef 100644
--- a/api_docs/kbn_core_analytics_server_mocks.mdx
+++ b/api_docs/kbn_core_analytics_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks
title: "@kbn/core-analytics-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-analytics-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-mocks']
---
import kbnCoreAnalyticsServerMocksObj from './kbn_core_analytics_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_application_browser.devdocs.json b/api_docs/kbn_core_application_browser.devdocs.json
index ce45e4231a999..e39e481fd8065 100644
--- a/api_docs/kbn_core_application_browser.devdocs.json
+++ b/api_docs/kbn_core_application_browser.devdocs.json
@@ -821,7 +821,7 @@
"tags": [],
"label": "navigateToApp",
"description": [
- "\nNavigate to a given app\n"
+ "\nNavigate to a given app.\nIf a plugin is disabled any applications it registers won't be available either.\nBefore rendering a UI element that a user could use to navigate to another application,\nfirst check if the destination application is actually available using the isAppRegistered API.\n"
],
"signature": [
"(appId: string, options?: ",
@@ -844,7 +844,9 @@
"type": "string",
"tags": [],
"label": "appId",
- "description": [],
+ "description": [
+ "- The identifier of the app to navigate to"
+ ],
"signature": [
"string"
],
@@ -948,6 +950,44 @@
],
"returnComment": []
},
+ {
+ "parentPluginId": "@kbn/core-application-browser",
+ "id": "def-public.ApplicationStart.isAppRegistered",
+ "type": "Function",
+ "tags": [],
+ "label": "isAppRegistered",
+ "description": [
+ "\nChecks whether a given application is registered.\n"
+ ],
+ "signature": [
+ "(appId: string) => boolean"
+ ],
+ "path": "packages/core/application/core-application-browser/src/contracts.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/core-application-browser",
+ "id": "def-public.ApplicationStart.isAppRegistered.$1",
+ "type": "string",
+ "tags": [],
+ "label": "appId",
+ "description": [
+ "- The identifier of the app to check"
+ ],
+ "signature": [
+ "string"
+ ],
+ "path": "packages/core/application/core-application-browser/src/contracts.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [
+ "true if the given appId is registered in the system, false otherwise."
+ ]
+ },
{
"parentPluginId": "@kbn/core-application-browser",
"id": "def-public.ApplicationStart.getUrlForApp",
diff --git a/api_docs/kbn_core_application_browser.mdx b/api_docs/kbn_core_application_browser.mdx
index 774cfe9f7bd1f..41e98c61c7b10 100644
--- a/api_docs/kbn_core_application_browser.mdx
+++ b/api_docs/kbn_core_application_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser
title: "@kbn/core-application-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-application-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser']
---
import kbnCoreApplicationBrowserObj from './kbn_core_application_browser.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 103 | 0 | 27 | 0 |
+| 105 | 0 | 26 | 0 |
## Client
diff --git a/api_docs/kbn_core_application_browser_internal.mdx b/api_docs/kbn_core_application_browser_internal.mdx
index d2deace2053a8..9ab8b905be0a4 100644
--- a/api_docs/kbn_core_application_browser_internal.mdx
+++ b/api_docs/kbn_core_application_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-internal
title: "@kbn/core-application-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-application-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-internal']
---
import kbnCoreApplicationBrowserInternalObj from './kbn_core_application_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_application_browser_mocks.mdx b/api_docs/kbn_core_application_browser_mocks.mdx
index 97c21aa5359e9..ba80dacb6b538 100644
--- a/api_docs/kbn_core_application_browser_mocks.mdx
+++ b/api_docs/kbn_core_application_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-mocks
title: "@kbn/core-application-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-application-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-mocks']
---
import kbnCoreApplicationBrowserMocksObj from './kbn_core_application_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_application_common.mdx b/api_docs/kbn_core_application_common.mdx
index 06d0490f716a0..36bdcfaab3c47 100644
--- a/api_docs/kbn_core_application_common.mdx
+++ b/api_docs/kbn_core_application_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-common
title: "@kbn/core-application-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-application-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-common']
---
import kbnCoreApplicationCommonObj from './kbn_core_application_common.devdocs.json';
diff --git a/api_docs/kbn_core_apps_browser_internal.mdx b/api_docs/kbn_core_apps_browser_internal.mdx
index 44173a8db46cb..8912e77c01483 100644
--- a/api_docs/kbn_core_apps_browser_internal.mdx
+++ b/api_docs/kbn_core_apps_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-internal
title: "@kbn/core-apps-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-apps-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-internal']
---
import kbnCoreAppsBrowserInternalObj from './kbn_core_apps_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_apps_browser_mocks.mdx b/api_docs/kbn_core_apps_browser_mocks.mdx
index 6416022ea18d4..76247ada48e80 100644
--- a/api_docs/kbn_core_apps_browser_mocks.mdx
+++ b/api_docs/kbn_core_apps_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-mocks
title: "@kbn/core-apps-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-apps-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-mocks']
---
import kbnCoreAppsBrowserMocksObj from './kbn_core_apps_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_apps_server_internal.mdx b/api_docs/kbn_core_apps_server_internal.mdx
index 016f5dd349d6b..4022e94b9c205 100644
--- a/api_docs/kbn_core_apps_server_internal.mdx
+++ b/api_docs/kbn_core_apps_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-server-internal
title: "@kbn/core-apps-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-apps-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-server-internal']
---
import kbnCoreAppsServerInternalObj from './kbn_core_apps_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx
index 9ead8fda9aa1e..d0d3d77db6ebf 100644
--- a/api_docs/kbn_core_base_browser_mocks.mdx
+++ b/api_docs/kbn_core_base_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks
title: "@kbn/core-base-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-base-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks']
---
import kbnCoreBaseBrowserMocksObj from './kbn_core_base_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx
index 3f201eaf70f69..410580465903f 100644
--- a/api_docs/kbn_core_base_common.mdx
+++ b/api_docs/kbn_core_base_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common
title: "@kbn/core-base-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-base-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common']
---
import kbnCoreBaseCommonObj from './kbn_core_base_common.devdocs.json';
diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx
index 0d6fbe4caf5c2..c8ba1cae31acd 100644
--- a/api_docs/kbn_core_base_server_internal.mdx
+++ b/api_docs/kbn_core_base_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-internal
title: "@kbn/core-base-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-base-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-internal']
---
import kbnCoreBaseServerInternalObj from './kbn_core_base_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx
index c262601e39390..3c69bcccbf111 100644
--- a/api_docs/kbn_core_base_server_mocks.mdx
+++ b/api_docs/kbn_core_base_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks
title: "@kbn/core-base-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-base-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks']
---
import kbnCoreBaseServerMocksObj from './kbn_core_base_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_capabilities_browser_mocks.mdx b/api_docs/kbn_core_capabilities_browser_mocks.mdx
index 1397357bfc260..d9439db1fbd9c 100644
--- a/api_docs/kbn_core_capabilities_browser_mocks.mdx
+++ b/api_docs/kbn_core_capabilities_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-browser-mocks
title: "@kbn/core-capabilities-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-capabilities-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-browser-mocks']
---
import kbnCoreCapabilitiesBrowserMocksObj from './kbn_core_capabilities_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_capabilities_common.mdx b/api_docs/kbn_core_capabilities_common.mdx
index e949963a9f027..58abd5481c9ab 100644
--- a/api_docs/kbn_core_capabilities_common.mdx
+++ b/api_docs/kbn_core_capabilities_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-common
title: "@kbn/core-capabilities-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-capabilities-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-common']
---
import kbnCoreCapabilitiesCommonObj from './kbn_core_capabilities_common.devdocs.json';
diff --git a/api_docs/kbn_core_capabilities_server.mdx b/api_docs/kbn_core_capabilities_server.mdx
index c71586dbc120c..069928c2ab5ce 100644
--- a/api_docs/kbn_core_capabilities_server.mdx
+++ b/api_docs/kbn_core_capabilities_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server
title: "@kbn/core-capabilities-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-capabilities-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server']
---
import kbnCoreCapabilitiesServerObj from './kbn_core_capabilities_server.devdocs.json';
diff --git a/api_docs/kbn_core_capabilities_server_mocks.mdx b/api_docs/kbn_core_capabilities_server_mocks.mdx
index fc2252da9efa4..ab617838b8f53 100644
--- a/api_docs/kbn_core_capabilities_server_mocks.mdx
+++ b/api_docs/kbn_core_capabilities_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server-mocks
title: "@kbn/core-capabilities-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-capabilities-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server-mocks']
---
import kbnCoreCapabilitiesServerMocksObj from './kbn_core_capabilities_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_chrome_browser.mdx b/api_docs/kbn_core_chrome_browser.mdx
index 021c71522c11a..e62f887465c64 100644
--- a/api_docs/kbn_core_chrome_browser.mdx
+++ b/api_docs/kbn_core_chrome_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser
title: "@kbn/core-chrome-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-chrome-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser']
---
import kbnCoreChromeBrowserObj from './kbn_core_chrome_browser.devdocs.json';
diff --git a/api_docs/kbn_core_chrome_browser_mocks.mdx b/api_docs/kbn_core_chrome_browser_mocks.mdx
index b70309e96806b..2c196fad44448 100644
--- a/api_docs/kbn_core_chrome_browser_mocks.mdx
+++ b/api_docs/kbn_core_chrome_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser-mocks
title: "@kbn/core-chrome-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-chrome-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser-mocks']
---
import kbnCoreChromeBrowserMocksObj from './kbn_core_chrome_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_config_server_internal.mdx b/api_docs/kbn_core_config_server_internal.mdx
index a218eb2897445..4c86c5f52196b 100644
--- a/api_docs/kbn_core_config_server_internal.mdx
+++ b/api_docs/kbn_core_config_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-config-server-internal
title: "@kbn/core-config-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-config-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-config-server-internal']
---
import kbnCoreConfigServerInternalObj from './kbn_core_config_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_custom_branding_browser.mdx b/api_docs/kbn_core_custom_branding_browser.mdx
index 132ccf86197d2..612934008322c 100644
--- a/api_docs/kbn_core_custom_branding_browser.mdx
+++ b/api_docs/kbn_core_custom_branding_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser
title: "@kbn/core-custom-branding-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-custom-branding-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser']
---
import kbnCoreCustomBrandingBrowserObj from './kbn_core_custom_branding_browser.devdocs.json';
diff --git a/api_docs/kbn_core_custom_branding_browser_internal.mdx b/api_docs/kbn_core_custom_branding_browser_internal.mdx
index 3135fd2e66214..77c1e8e61e6f8 100644
--- a/api_docs/kbn_core_custom_branding_browser_internal.mdx
+++ b/api_docs/kbn_core_custom_branding_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-internal
title: "@kbn/core-custom-branding-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-custom-branding-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser-internal']
---
import kbnCoreCustomBrandingBrowserInternalObj from './kbn_core_custom_branding_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_custom_branding_browser_mocks.mdx b/api_docs/kbn_core_custom_branding_browser_mocks.mdx
index bea12e7dac641..393957b100011 100644
--- a/api_docs/kbn_core_custom_branding_browser_mocks.mdx
+++ b/api_docs/kbn_core_custom_branding_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-mocks
title: "@kbn/core-custom-branding-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-custom-branding-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser-mocks']
---
import kbnCoreCustomBrandingBrowserMocksObj from './kbn_core_custom_branding_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_custom_branding_common.mdx b/api_docs/kbn_core_custom_branding_common.mdx
index 779c45b3fcae1..db3ad9c744bea 100644
--- a/api_docs/kbn_core_custom_branding_common.mdx
+++ b/api_docs/kbn_core_custom_branding_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-common
title: "@kbn/core-custom-branding-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-custom-branding-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-common']
---
import kbnCoreCustomBrandingCommonObj from './kbn_core_custom_branding_common.devdocs.json';
diff --git a/api_docs/kbn_core_custom_branding_server.mdx b/api_docs/kbn_core_custom_branding_server.mdx
index 40b93b73f3a09..216c37c384611 100644
--- a/api_docs/kbn_core_custom_branding_server.mdx
+++ b/api_docs/kbn_core_custom_branding_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server
title: "@kbn/core-custom-branding-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-custom-branding-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server']
---
import kbnCoreCustomBrandingServerObj from './kbn_core_custom_branding_server.devdocs.json';
diff --git a/api_docs/kbn_core_custom_branding_server_internal.mdx b/api_docs/kbn_core_custom_branding_server_internal.mdx
index c8dee89640725..2a4f666101ee1 100644
--- a/api_docs/kbn_core_custom_branding_server_internal.mdx
+++ b/api_docs/kbn_core_custom_branding_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-internal
title: "@kbn/core-custom-branding-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-custom-branding-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-internal']
---
import kbnCoreCustomBrandingServerInternalObj from './kbn_core_custom_branding_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_custom_branding_server_mocks.mdx b/api_docs/kbn_core_custom_branding_server_mocks.mdx
index c70c995a87c0d..2e1c29033464f 100644
--- a/api_docs/kbn_core_custom_branding_server_mocks.mdx
+++ b/api_docs/kbn_core_custom_branding_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-mocks
title: "@kbn/core-custom-branding-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-custom-branding-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-mocks']
---
import kbnCoreCustomBrandingServerMocksObj from './kbn_core_custom_branding_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_deprecations_browser.mdx b/api_docs/kbn_core_deprecations_browser.mdx
index 14e19daf5f5e6..ea85a33b09557 100644
--- a/api_docs/kbn_core_deprecations_browser.mdx
+++ b/api_docs/kbn_core_deprecations_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser
title: "@kbn/core-deprecations-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-deprecations-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser']
---
import kbnCoreDeprecationsBrowserObj from './kbn_core_deprecations_browser.devdocs.json';
diff --git a/api_docs/kbn_core_deprecations_browser_internal.mdx b/api_docs/kbn_core_deprecations_browser_internal.mdx
index aa2dcb2605aab..2c14b71be0709 100644
--- a/api_docs/kbn_core_deprecations_browser_internal.mdx
+++ b/api_docs/kbn_core_deprecations_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-internal
title: "@kbn/core-deprecations-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-deprecations-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-internal']
---
import kbnCoreDeprecationsBrowserInternalObj from './kbn_core_deprecations_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_deprecations_browser_mocks.mdx b/api_docs/kbn_core_deprecations_browser_mocks.mdx
index 3724ce30fcca2..7a25f842e3a98 100644
--- a/api_docs/kbn_core_deprecations_browser_mocks.mdx
+++ b/api_docs/kbn_core_deprecations_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-mocks
title: "@kbn/core-deprecations-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-deprecations-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-mocks']
---
import kbnCoreDeprecationsBrowserMocksObj from './kbn_core_deprecations_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_deprecations_common.mdx b/api_docs/kbn_core_deprecations_common.mdx
index b2b55b67b21e1..2cc42811c0f6e 100644
--- a/api_docs/kbn_core_deprecations_common.mdx
+++ b/api_docs/kbn_core_deprecations_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-common
title: "@kbn/core-deprecations-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-deprecations-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-common']
---
import kbnCoreDeprecationsCommonObj from './kbn_core_deprecations_common.devdocs.json';
diff --git a/api_docs/kbn_core_deprecations_server.mdx b/api_docs/kbn_core_deprecations_server.mdx
index dd31135b6347a..e5b802e754ab7 100644
--- a/api_docs/kbn_core_deprecations_server.mdx
+++ b/api_docs/kbn_core_deprecations_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server
title: "@kbn/core-deprecations-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-deprecations-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server']
---
import kbnCoreDeprecationsServerObj from './kbn_core_deprecations_server.devdocs.json';
diff --git a/api_docs/kbn_core_deprecations_server_internal.mdx b/api_docs/kbn_core_deprecations_server_internal.mdx
index 4d44a40acbf42..04d10852eac21 100644
--- a/api_docs/kbn_core_deprecations_server_internal.mdx
+++ b/api_docs/kbn_core_deprecations_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-internal
title: "@kbn/core-deprecations-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-deprecations-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server-internal']
---
import kbnCoreDeprecationsServerInternalObj from './kbn_core_deprecations_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_deprecations_server_mocks.mdx b/api_docs/kbn_core_deprecations_server_mocks.mdx
index d13fbddfaaf83..7bfa7570b377c 100644
--- a/api_docs/kbn_core_deprecations_server_mocks.mdx
+++ b/api_docs/kbn_core_deprecations_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-mocks
title: "@kbn/core-deprecations-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-deprecations-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server-mocks']
---
import kbnCoreDeprecationsServerMocksObj from './kbn_core_deprecations_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx
index 412fa09bcaf36..94a7334e088ea 100644
--- a/api_docs/kbn_core_doc_links_browser.mdx
+++ b/api_docs/kbn_core_doc_links_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser
title: "@kbn/core-doc-links-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-doc-links-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser']
---
import kbnCoreDocLinksBrowserObj from './kbn_core_doc_links_browser.devdocs.json';
diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx
index 03e26cf50732c..3b41f4c7680d2 100644
--- a/api_docs/kbn_core_doc_links_browser_mocks.mdx
+++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks
title: "@kbn/core-doc-links-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-doc-links-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks']
---
import kbnCoreDocLinksBrowserMocksObj from './kbn_core_doc_links_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx
index 1eeee02b110cb..2d1952fec0ac0 100644
--- a/api_docs/kbn_core_doc_links_server.mdx
+++ b/api_docs/kbn_core_doc_links_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server
title: "@kbn/core-doc-links-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-doc-links-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server']
---
import kbnCoreDocLinksServerObj from './kbn_core_doc_links_server.devdocs.json';
diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx
index 832b77ffac1c2..787622f205096 100644
--- a/api_docs/kbn_core_doc_links_server_mocks.mdx
+++ b/api_docs/kbn_core_doc_links_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks
title: "@kbn/core-doc-links-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-doc-links-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks']
---
import kbnCoreDocLinksServerMocksObj from './kbn_core_doc_links_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx
index e7f7730d40c5d..33192322e4abb 100644
--- a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx
+++ b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-internal
title: "@kbn/core-elasticsearch-client-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-elasticsearch-client-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-internal']
---
import kbnCoreElasticsearchClientServerInternalObj from './kbn_core_elasticsearch_client_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx
index 9cb619655a641..f30d9adb9a1f6 100644
--- a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx
+++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-mocks
title: "@kbn/core-elasticsearch-client-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-elasticsearch-client-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-mocks']
---
import kbnCoreElasticsearchClientServerMocksObj from './kbn_core_elasticsearch_client_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_elasticsearch_server.mdx b/api_docs/kbn_core_elasticsearch_server.mdx
index 4f96e787d24d2..c08744f061496 100644
--- a/api_docs/kbn_core_elasticsearch_server.mdx
+++ b/api_docs/kbn_core_elasticsearch_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server
title: "@kbn/core-elasticsearch-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-elasticsearch-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server']
---
import kbnCoreElasticsearchServerObj from './kbn_core_elasticsearch_server.devdocs.json';
diff --git a/api_docs/kbn_core_elasticsearch_server_internal.mdx b/api_docs/kbn_core_elasticsearch_server_internal.mdx
index b3a5033bb4586..c5f61648bd317 100644
--- a/api_docs/kbn_core_elasticsearch_server_internal.mdx
+++ b/api_docs/kbn_core_elasticsearch_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-internal
title: "@kbn/core-elasticsearch-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-elasticsearch-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-internal']
---
import kbnCoreElasticsearchServerInternalObj from './kbn_core_elasticsearch_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_server_mocks.mdx
index f24ee0149659e..4cb12e63ff41a 100644
--- a/api_docs/kbn_core_elasticsearch_server_mocks.mdx
+++ b/api_docs/kbn_core_elasticsearch_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-mocks
title: "@kbn/core-elasticsearch-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-elasticsearch-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-mocks']
---
import kbnCoreElasticsearchServerMocksObj from './kbn_core_elasticsearch_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_environment_server_internal.mdx b/api_docs/kbn_core_environment_server_internal.mdx
index 84257830edf15..1a5758e2e5652 100644
--- a/api_docs/kbn_core_environment_server_internal.mdx
+++ b/api_docs/kbn_core_environment_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-internal
title: "@kbn/core-environment-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-environment-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-internal']
---
import kbnCoreEnvironmentServerInternalObj from './kbn_core_environment_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_environment_server_mocks.mdx b/api_docs/kbn_core_environment_server_mocks.mdx
index c39dad6af5998..aa3fa1d30d1bf 100644
--- a/api_docs/kbn_core_environment_server_mocks.mdx
+++ b/api_docs/kbn_core_environment_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-mocks
title: "@kbn/core-environment-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-environment-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-mocks']
---
import kbnCoreEnvironmentServerMocksObj from './kbn_core_environment_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_execution_context_browser.mdx b/api_docs/kbn_core_execution_context_browser.mdx
index 6099830fd7c4e..deecbca75d8ff 100644
--- a/api_docs/kbn_core_execution_context_browser.mdx
+++ b/api_docs/kbn_core_execution_context_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser
title: "@kbn/core-execution-context-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-execution-context-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser']
---
import kbnCoreExecutionContextBrowserObj from './kbn_core_execution_context_browser.devdocs.json';
diff --git a/api_docs/kbn_core_execution_context_browser_internal.mdx b/api_docs/kbn_core_execution_context_browser_internal.mdx
index 657792f5d404e..f97ad06a613c5 100644
--- a/api_docs/kbn_core_execution_context_browser_internal.mdx
+++ b/api_docs/kbn_core_execution_context_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-internal
title: "@kbn/core-execution-context-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-execution-context-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-internal']
---
import kbnCoreExecutionContextBrowserInternalObj from './kbn_core_execution_context_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_execution_context_browser_mocks.mdx b/api_docs/kbn_core_execution_context_browser_mocks.mdx
index 679f91b753896..3b80afc0526e0 100644
--- a/api_docs/kbn_core_execution_context_browser_mocks.mdx
+++ b/api_docs/kbn_core_execution_context_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-mocks
title: "@kbn/core-execution-context-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-execution-context-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-mocks']
---
import kbnCoreExecutionContextBrowserMocksObj from './kbn_core_execution_context_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_execution_context_common.mdx b/api_docs/kbn_core_execution_context_common.mdx
index f8b344dc5991c..5e3e80b579bac 100644
--- a/api_docs/kbn_core_execution_context_common.mdx
+++ b/api_docs/kbn_core_execution_context_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-common
title: "@kbn/core-execution-context-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-execution-context-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-common']
---
import kbnCoreExecutionContextCommonObj from './kbn_core_execution_context_common.devdocs.json';
diff --git a/api_docs/kbn_core_execution_context_server.mdx b/api_docs/kbn_core_execution_context_server.mdx
index 2b3ad97f9ea5a..a1c7646dc7a52 100644
--- a/api_docs/kbn_core_execution_context_server.mdx
+++ b/api_docs/kbn_core_execution_context_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server
title: "@kbn/core-execution-context-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-execution-context-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server']
---
import kbnCoreExecutionContextServerObj from './kbn_core_execution_context_server.devdocs.json';
diff --git a/api_docs/kbn_core_execution_context_server_internal.mdx b/api_docs/kbn_core_execution_context_server_internal.mdx
index b0d8b1f516e00..d85d3caaf1175 100644
--- a/api_docs/kbn_core_execution_context_server_internal.mdx
+++ b/api_docs/kbn_core_execution_context_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-internal
title: "@kbn/core-execution-context-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-execution-context-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-internal']
---
import kbnCoreExecutionContextServerInternalObj from './kbn_core_execution_context_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_execution_context_server_mocks.mdx b/api_docs/kbn_core_execution_context_server_mocks.mdx
index b28f91c0f32e4..a971abc5ee8c0 100644
--- a/api_docs/kbn_core_execution_context_server_mocks.mdx
+++ b/api_docs/kbn_core_execution_context_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-mocks
title: "@kbn/core-execution-context-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-execution-context-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-mocks']
---
import kbnCoreExecutionContextServerMocksObj from './kbn_core_execution_context_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_fatal_errors_browser.mdx b/api_docs/kbn_core_fatal_errors_browser.mdx
index b0d481d708234..1a79b55ab4c44 100644
--- a/api_docs/kbn_core_fatal_errors_browser.mdx
+++ b/api_docs/kbn_core_fatal_errors_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser
title: "@kbn/core-fatal-errors-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-fatal-errors-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser']
---
import kbnCoreFatalErrorsBrowserObj from './kbn_core_fatal_errors_browser.devdocs.json';
diff --git a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx
index 56ca8ad13b23c..f7652302429f5 100644
--- a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx
+++ b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser-mocks
title: "@kbn/core-fatal-errors-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-fatal-errors-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser-mocks']
---
import kbnCoreFatalErrorsBrowserMocksObj from './kbn_core_fatal_errors_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_feature_flags_browser.mdx b/api_docs/kbn_core_feature_flags_browser.mdx
index c8068c0b0753b..896725387f216 100644
--- a/api_docs/kbn_core_feature_flags_browser.mdx
+++ b/api_docs/kbn_core_feature_flags_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-feature-flags-browser
title: "@kbn/core-feature-flags-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-feature-flags-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-feature-flags-browser']
---
import kbnCoreFeatureFlagsBrowserObj from './kbn_core_feature_flags_browser.devdocs.json';
diff --git a/api_docs/kbn_core_feature_flags_browser_internal.mdx b/api_docs/kbn_core_feature_flags_browser_internal.mdx
index e6f0ba9752013..6cd0e3221aab2 100644
--- a/api_docs/kbn_core_feature_flags_browser_internal.mdx
+++ b/api_docs/kbn_core_feature_flags_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-feature-flags-browser-internal
title: "@kbn/core-feature-flags-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-feature-flags-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-feature-flags-browser-internal']
---
import kbnCoreFeatureFlagsBrowserInternalObj from './kbn_core_feature_flags_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_feature_flags_browser_mocks.mdx b/api_docs/kbn_core_feature_flags_browser_mocks.mdx
index 4d2036685a2be..9ca45dc6fb9aa 100644
--- a/api_docs/kbn_core_feature_flags_browser_mocks.mdx
+++ b/api_docs/kbn_core_feature_flags_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-feature-flags-browser-mocks
title: "@kbn/core-feature-flags-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-feature-flags-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-feature-flags-browser-mocks']
---
import kbnCoreFeatureFlagsBrowserMocksObj from './kbn_core_feature_flags_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_feature_flags_server.mdx b/api_docs/kbn_core_feature_flags_server.mdx
index 5621486722d70..5b4803595ef4e 100644
--- a/api_docs/kbn_core_feature_flags_server.mdx
+++ b/api_docs/kbn_core_feature_flags_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-feature-flags-server
title: "@kbn/core-feature-flags-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-feature-flags-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-feature-flags-server']
---
import kbnCoreFeatureFlagsServerObj from './kbn_core_feature_flags_server.devdocs.json';
diff --git a/api_docs/kbn_core_feature_flags_server_internal.mdx b/api_docs/kbn_core_feature_flags_server_internal.mdx
index a49a6bae7b177..57dccbfc29ec7 100644
--- a/api_docs/kbn_core_feature_flags_server_internal.mdx
+++ b/api_docs/kbn_core_feature_flags_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-feature-flags-server-internal
title: "@kbn/core-feature-flags-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-feature-flags-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-feature-flags-server-internal']
---
import kbnCoreFeatureFlagsServerInternalObj from './kbn_core_feature_flags_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_feature_flags_server_mocks.mdx b/api_docs/kbn_core_feature_flags_server_mocks.mdx
index 7d6655e84eac2..51b3fcaf34305 100644
--- a/api_docs/kbn_core_feature_flags_server_mocks.mdx
+++ b/api_docs/kbn_core_feature_flags_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-feature-flags-server-mocks
title: "@kbn/core-feature-flags-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-feature-flags-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-feature-flags-server-mocks']
---
import kbnCoreFeatureFlagsServerMocksObj from './kbn_core_feature_flags_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_http_browser.mdx b/api_docs/kbn_core_http_browser.mdx
index e73ecd24ddbc7..b8e8e77183f88 100644
--- a/api_docs/kbn_core_http_browser.mdx
+++ b/api_docs/kbn_core_http_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser
title: "@kbn/core-http-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser']
---
import kbnCoreHttpBrowserObj from './kbn_core_http_browser.devdocs.json';
diff --git a/api_docs/kbn_core_http_browser_internal.mdx b/api_docs/kbn_core_http_browser_internal.mdx
index 27b99df99188b..ed011886ccb39 100644
--- a/api_docs/kbn_core_http_browser_internal.mdx
+++ b/api_docs/kbn_core_http_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-internal
title: "@kbn/core-http-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-internal']
---
import kbnCoreHttpBrowserInternalObj from './kbn_core_http_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx
index df5b653105da1..1e7bd8f6c7991 100644
--- a/api_docs/kbn_core_http_browser_mocks.mdx
+++ b/api_docs/kbn_core_http_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-mocks
title: "@kbn/core-http-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-mocks']
---
import kbnCoreHttpBrowserMocksObj from './kbn_core_http_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx
index d1f789a2d9357..8fa4d01d88e16 100644
--- a/api_docs/kbn_core_http_common.mdx
+++ b/api_docs/kbn_core_http_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-common
title: "@kbn/core-http-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-common']
---
import kbnCoreHttpCommonObj from './kbn_core_http_common.devdocs.json';
diff --git a/api_docs/kbn_core_http_context_server_mocks.mdx b/api_docs/kbn_core_http_context_server_mocks.mdx
index 37bf2bc199237..d9005ba407dc5 100644
--- a/api_docs/kbn_core_http_context_server_mocks.mdx
+++ b/api_docs/kbn_core_http_context_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-context-server-mocks
title: "@kbn/core-http-context-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-context-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-context-server-mocks']
---
import kbnCoreHttpContextServerMocksObj from './kbn_core_http_context_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_http_request_handler_context_server.mdx b/api_docs/kbn_core_http_request_handler_context_server.mdx
index bac47d59ba0fe..44affb1d5b18f 100644
--- a/api_docs/kbn_core_http_request_handler_context_server.mdx
+++ b/api_docs/kbn_core_http_request_handler_context_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-request-handler-context-server
title: "@kbn/core-http-request-handler-context-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-request-handler-context-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-request-handler-context-server']
---
import kbnCoreHttpRequestHandlerContextServerObj from './kbn_core_http_request_handler_context_server.devdocs.json';
diff --git a/api_docs/kbn_core_http_resources_server.mdx b/api_docs/kbn_core_http_resources_server.mdx
index 6a23793a096f1..628fb6d0bc1f0 100644
--- a/api_docs/kbn_core_http_resources_server.mdx
+++ b/api_docs/kbn_core_http_resources_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server
title: "@kbn/core-http-resources-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-resources-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server']
---
import kbnCoreHttpResourcesServerObj from './kbn_core_http_resources_server.devdocs.json';
diff --git a/api_docs/kbn_core_http_resources_server_internal.mdx b/api_docs/kbn_core_http_resources_server_internal.mdx
index 7a061ec4f8f08..053274647e7bb 100644
--- a/api_docs/kbn_core_http_resources_server_internal.mdx
+++ b/api_docs/kbn_core_http_resources_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-internal
title: "@kbn/core-http-resources-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-resources-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-internal']
---
import kbnCoreHttpResourcesServerInternalObj from './kbn_core_http_resources_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_http_resources_server_mocks.mdx b/api_docs/kbn_core_http_resources_server_mocks.mdx
index 9b7719f10a7d0..0f542e5180dd5 100644
--- a/api_docs/kbn_core_http_resources_server_mocks.mdx
+++ b/api_docs/kbn_core_http_resources_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-mocks
title: "@kbn/core-http-resources-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-resources-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-mocks']
---
import kbnCoreHttpResourcesServerMocksObj from './kbn_core_http_resources_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_http_router_server_internal.mdx b/api_docs/kbn_core_http_router_server_internal.mdx
index 67073867e119e..0640a6d6fb56c 100644
--- a/api_docs/kbn_core_http_router_server_internal.mdx
+++ b/api_docs/kbn_core_http_router_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-internal
title: "@kbn/core-http-router-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-router-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-internal']
---
import kbnCoreHttpRouterServerInternalObj from './kbn_core_http_router_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_http_router_server_mocks.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx
index 25c412552d0e5..952ce7dcfbafc 100644
--- a/api_docs/kbn_core_http_router_server_mocks.mdx
+++ b/api_docs/kbn_core_http_router_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-mocks
title: "@kbn/core-http-router-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-router-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-mocks']
---
import kbnCoreHttpRouterServerMocksObj from './kbn_core_http_router_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_http_server.devdocs.json b/api_docs/kbn_core_http_server.devdocs.json
index 96ad9f9d09e62..e9776fff2334a 100644
--- a/api_docs/kbn_core_http_server.devdocs.json
+++ b/api_docs/kbn_core_http_server.devdocs.json
@@ -14120,16 +14120,16 @@
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
- "section": "def-server.AuthzDisabled",
- "text": "AuthzDisabled"
+ "section": "def-server.AuthzEnabled",
+ "text": "AuthzEnabled"
},
" | ",
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
- "section": "def-server.AuthzEnabled",
- "text": "AuthzEnabled"
+ "section": "def-server.AuthzDisabled",
+ "text": "AuthzDisabled"
}
],
"path": "packages/core/http/core-http-server/src/router/route.ts",
@@ -16014,7 +16014,7 @@
},
{
"plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/index.ts"
+ "path": "x-pack/plugins/security_solution/server/lib/siem_migrations/rules/api/resources/get.ts"
},
{
"plugin": "securitySolution",
@@ -16032,10 +16032,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/index.ts"
},
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/index.ts"
- },
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/file_info_handler.ts"
@@ -16056,10 +16052,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/state.ts"
},
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/audit_log.ts"
- },
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/list.ts"
@@ -16543,6 +16535,10 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/lib/siem_migrations/rules/api/stop.ts"
},
+ {
+ "plugin": "securitySolution",
+ "path": "x-pack/plugins/security_solution/server/lib/siem_migrations/rules/api/retry.ts"
+ },
{
"plugin": "transform",
"path": "x-pack/plugins/transform/server/routes/api/transforms_create/register_route.ts"
@@ -17556,7 +17552,7 @@
},
{
"plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts"
+ "path": "x-pack/plugins/security_solution/server/lib/siem_migrations/rules/api/resources/upsert.ts"
},
{
"plugin": "securitySolution",
@@ -17594,14 +17590,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts"
},
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts"
- },
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.ts"
- },
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.ts"
@@ -20695,16 +20683,16 @@
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
- "section": "def-server.AuthzDisabled",
- "text": "AuthzDisabled"
+ "section": "def-server.AuthzEnabled",
+ "text": "AuthzEnabled"
},
" | ",
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
- "section": "def-server.AuthzEnabled",
- "text": "AuthzEnabled"
+ "section": "def-server.AuthzDisabled",
+ "text": "AuthzDisabled"
}
],
"path": "packages/core/http/core-http-server/src/router/route.ts",
diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx
index bef9a4f513272..03588726dfbb5 100644
--- a/api_docs/kbn_core_http_server.mdx
+++ b/api_docs/kbn_core_http_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server
title: "@kbn/core-http-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server']
---
import kbnCoreHttpServerObj from './kbn_core_http_server.devdocs.json';
diff --git a/api_docs/kbn_core_http_server_internal.mdx b/api_docs/kbn_core_http_server_internal.mdx
index ce7364953264b..2719822c7e21a 100644
--- a/api_docs/kbn_core_http_server_internal.mdx
+++ b/api_docs/kbn_core_http_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-internal
title: "@kbn/core-http-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-internal']
---
import kbnCoreHttpServerInternalObj from './kbn_core_http_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_http_server_mocks.mdx b/api_docs/kbn_core_http_server_mocks.mdx
index 0897c0e40d9c5..b999b5e544dfd 100644
--- a/api_docs/kbn_core_http_server_mocks.mdx
+++ b/api_docs/kbn_core_http_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-mocks
title: "@kbn/core-http-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-http-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-mocks']
---
import kbnCoreHttpServerMocksObj from './kbn_core_http_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_i18n_browser.mdx b/api_docs/kbn_core_i18n_browser.mdx
index c095b3e91078e..fdbe6fffd8f2d 100644
--- a/api_docs/kbn_core_i18n_browser.mdx
+++ b/api_docs/kbn_core_i18n_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser
title: "@kbn/core-i18n-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-i18n-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser']
---
import kbnCoreI18nBrowserObj from './kbn_core_i18n_browser.devdocs.json';
diff --git a/api_docs/kbn_core_i18n_browser_mocks.mdx b/api_docs/kbn_core_i18n_browser_mocks.mdx
index 720390f6febb5..861b792cc4c10 100644
--- a/api_docs/kbn_core_i18n_browser_mocks.mdx
+++ b/api_docs/kbn_core_i18n_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks
title: "@kbn/core-i18n-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-i18n-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser-mocks']
---
import kbnCoreI18nBrowserMocksObj from './kbn_core_i18n_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_i18n_server.mdx b/api_docs/kbn_core_i18n_server.mdx
index 33d3a4578cc3b..4709e4cb197fc 100644
--- a/api_docs/kbn_core_i18n_server.mdx
+++ b/api_docs/kbn_core_i18n_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server
title: "@kbn/core-i18n-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-i18n-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server']
---
import kbnCoreI18nServerObj from './kbn_core_i18n_server.devdocs.json';
diff --git a/api_docs/kbn_core_i18n_server_internal.mdx b/api_docs/kbn_core_i18n_server_internal.mdx
index 9a484303285f2..6e5ef309ae1ee 100644
--- a/api_docs/kbn_core_i18n_server_internal.mdx
+++ b/api_docs/kbn_core_i18n_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-internal
title: "@kbn/core-i18n-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-i18n-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-internal']
---
import kbnCoreI18nServerInternalObj from './kbn_core_i18n_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_i18n_server_mocks.mdx b/api_docs/kbn_core_i18n_server_mocks.mdx
index 671ea43a579b0..c44b21b1c26d7 100644
--- a/api_docs/kbn_core_i18n_server_mocks.mdx
+++ b/api_docs/kbn_core_i18n_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-mocks
title: "@kbn/core-i18n-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-i18n-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-mocks']
---
import kbnCoreI18nServerMocksObj from './kbn_core_i18n_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx
index e4581c0616c8c..c5592332e3dcd 100644
--- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx
+++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks
title: "@kbn/core-injected-metadata-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-injected-metadata-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks']
---
import kbnCoreInjectedMetadataBrowserMocksObj from './kbn_core_injected_metadata_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_integrations_browser_internal.mdx b/api_docs/kbn_core_integrations_browser_internal.mdx
index 0d0235d1390c6..74220604c717f 100644
--- a/api_docs/kbn_core_integrations_browser_internal.mdx
+++ b/api_docs/kbn_core_integrations_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-internal
title: "@kbn/core-integrations-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-integrations-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-internal']
---
import kbnCoreIntegrationsBrowserInternalObj from './kbn_core_integrations_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_integrations_browser_mocks.mdx b/api_docs/kbn_core_integrations_browser_mocks.mdx
index 9ad442b8b7e48..f54df075d8981 100644
--- a/api_docs/kbn_core_integrations_browser_mocks.mdx
+++ b/api_docs/kbn_core_integrations_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-mocks
title: "@kbn/core-integrations-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-integrations-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-mocks']
---
import kbnCoreIntegrationsBrowserMocksObj from './kbn_core_integrations_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_lifecycle_browser.mdx b/api_docs/kbn_core_lifecycle_browser.mdx
index 0c74c2dbccc93..dd92cb4957ef2 100644
--- a/api_docs/kbn_core_lifecycle_browser.mdx
+++ b/api_docs/kbn_core_lifecycle_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser
title: "@kbn/core-lifecycle-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-lifecycle-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-browser']
---
import kbnCoreLifecycleBrowserObj from './kbn_core_lifecycle_browser.devdocs.json';
diff --git a/api_docs/kbn_core_lifecycle_browser_mocks.mdx b/api_docs/kbn_core_lifecycle_browser_mocks.mdx
index 4cc0cd9fb7f5b..7fb35881b63da 100644
--- a/api_docs/kbn_core_lifecycle_browser_mocks.mdx
+++ b/api_docs/kbn_core_lifecycle_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser-mocks
title: "@kbn/core-lifecycle-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-lifecycle-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-browser-mocks']
---
import kbnCoreLifecycleBrowserMocksObj from './kbn_core_lifecycle_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_lifecycle_server.mdx b/api_docs/kbn_core_lifecycle_server.mdx
index 8b9e44229a691..2ef27eb90a560 100644
--- a/api_docs/kbn_core_lifecycle_server.mdx
+++ b/api_docs/kbn_core_lifecycle_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server
title: "@kbn/core-lifecycle-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-lifecycle-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server']
---
import kbnCoreLifecycleServerObj from './kbn_core_lifecycle_server.devdocs.json';
diff --git a/api_docs/kbn_core_lifecycle_server_mocks.mdx b/api_docs/kbn_core_lifecycle_server_mocks.mdx
index 7a166440c4fa9..1c83436fb026c 100644
--- a/api_docs/kbn_core_lifecycle_server_mocks.mdx
+++ b/api_docs/kbn_core_lifecycle_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server-mocks
title: "@kbn/core-lifecycle-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-lifecycle-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server-mocks']
---
import kbnCoreLifecycleServerMocksObj from './kbn_core_lifecycle_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_logging_browser_mocks.mdx b/api_docs/kbn_core_logging_browser_mocks.mdx
index 30c6829e42a6b..3afe790148f36 100644
--- a/api_docs/kbn_core_logging_browser_mocks.mdx
+++ b/api_docs/kbn_core_logging_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-browser-mocks
title: "@kbn/core-logging-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-logging-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-browser-mocks']
---
import kbnCoreLoggingBrowserMocksObj from './kbn_core_logging_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_logging_common_internal.mdx b/api_docs/kbn_core_logging_common_internal.mdx
index 38163fadd0a4f..62ada7a77eef6 100644
--- a/api_docs/kbn_core_logging_common_internal.mdx
+++ b/api_docs/kbn_core_logging_common_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-common-internal
title: "@kbn/core-logging-common-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-logging-common-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-common-internal']
---
import kbnCoreLoggingCommonInternalObj from './kbn_core_logging_common_internal.devdocs.json';
diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx
index 90c02caaf084d..6f1bce8c59f61 100644
--- a/api_docs/kbn_core_logging_server.mdx
+++ b/api_docs/kbn_core_logging_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server
title: "@kbn/core-logging-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-logging-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server']
---
import kbnCoreLoggingServerObj from './kbn_core_logging_server.devdocs.json';
diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx
index 1b9200780186d..0f989505ec60a 100644
--- a/api_docs/kbn_core_logging_server_internal.mdx
+++ b/api_docs/kbn_core_logging_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal
title: "@kbn/core-logging-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-logging-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal']
---
import kbnCoreLoggingServerInternalObj from './kbn_core_logging_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx
index e34976374e0ad..24705d2bbff82 100644
--- a/api_docs/kbn_core_logging_server_mocks.mdx
+++ b/api_docs/kbn_core_logging_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks
title: "@kbn/core-logging-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-logging-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks']
---
import kbnCoreLoggingServerMocksObj from './kbn_core_logging_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_metrics_collectors_server_internal.mdx b/api_docs/kbn_core_metrics_collectors_server_internal.mdx
index 18326c15e6a55..fe672db632eb1 100644
--- a/api_docs/kbn_core_metrics_collectors_server_internal.mdx
+++ b/api_docs/kbn_core_metrics_collectors_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-internal
title: "@kbn/core-metrics-collectors-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-metrics-collectors-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-internal']
---
import kbnCoreMetricsCollectorsServerInternalObj from './kbn_core_metrics_collectors_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx
index 46c8e39876b71..baf8baa98472f 100644
--- a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx
+++ b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-mocks
title: "@kbn/core-metrics-collectors-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-metrics-collectors-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-mocks']
---
import kbnCoreMetricsCollectorsServerMocksObj from './kbn_core_metrics_collectors_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_metrics_server.mdx b/api_docs/kbn_core_metrics_server.mdx
index dc1d835200e57..ae39936bfeb9e 100644
--- a/api_docs/kbn_core_metrics_server.mdx
+++ b/api_docs/kbn_core_metrics_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server
title: "@kbn/core-metrics-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-metrics-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server']
---
import kbnCoreMetricsServerObj from './kbn_core_metrics_server.devdocs.json';
diff --git a/api_docs/kbn_core_metrics_server_internal.mdx b/api_docs/kbn_core_metrics_server_internal.mdx
index 135f589c7d03e..9abc2eac564d5 100644
--- a/api_docs/kbn_core_metrics_server_internal.mdx
+++ b/api_docs/kbn_core_metrics_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-internal
title: "@kbn/core-metrics-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-metrics-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-internal']
---
import kbnCoreMetricsServerInternalObj from './kbn_core_metrics_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_metrics_server_mocks.mdx b/api_docs/kbn_core_metrics_server_mocks.mdx
index d162ca1fce926..d24775debc489 100644
--- a/api_docs/kbn_core_metrics_server_mocks.mdx
+++ b/api_docs/kbn_core_metrics_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-mocks
title: "@kbn/core-metrics-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-metrics-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-mocks']
---
import kbnCoreMetricsServerMocksObj from './kbn_core_metrics_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_mount_utils_browser.mdx b/api_docs/kbn_core_mount_utils_browser.mdx
index 05ea30ac0384e..99139726edfb5 100644
--- a/api_docs/kbn_core_mount_utils_browser.mdx
+++ b/api_docs/kbn_core_mount_utils_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-mount-utils-browser
title: "@kbn/core-mount-utils-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-mount-utils-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-mount-utils-browser']
---
import kbnCoreMountUtilsBrowserObj from './kbn_core_mount_utils_browser.devdocs.json';
diff --git a/api_docs/kbn_core_node_server.mdx b/api_docs/kbn_core_node_server.mdx
index a8c1bbbd5615f..01abfac45b349 100644
--- a/api_docs/kbn_core_node_server.mdx
+++ b/api_docs/kbn_core_node_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server
title: "@kbn/core-node-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-node-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server']
---
import kbnCoreNodeServerObj from './kbn_core_node_server.devdocs.json';
diff --git a/api_docs/kbn_core_node_server_internal.mdx b/api_docs/kbn_core_node_server_internal.mdx
index 0b6c62e105ba4..81e6aad648819 100644
--- a/api_docs/kbn_core_node_server_internal.mdx
+++ b/api_docs/kbn_core_node_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-internal
title: "@kbn/core-node-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-node-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-internal']
---
import kbnCoreNodeServerInternalObj from './kbn_core_node_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_node_server_mocks.mdx b/api_docs/kbn_core_node_server_mocks.mdx
index 0da3924478645..0e4201f6276ac 100644
--- a/api_docs/kbn_core_node_server_mocks.mdx
+++ b/api_docs/kbn_core_node_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-mocks
title: "@kbn/core-node-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-node-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-mocks']
---
import kbnCoreNodeServerMocksObj from './kbn_core_node_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_notifications_browser.mdx b/api_docs/kbn_core_notifications_browser.mdx
index 46d24815336ee..a2d52bb4183f9 100644
--- a/api_docs/kbn_core_notifications_browser.mdx
+++ b/api_docs/kbn_core_notifications_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser
title: "@kbn/core-notifications-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-notifications-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser']
---
import kbnCoreNotificationsBrowserObj from './kbn_core_notifications_browser.devdocs.json';
diff --git a/api_docs/kbn_core_notifications_browser_internal.mdx b/api_docs/kbn_core_notifications_browser_internal.mdx
index 54c58b3992aad..bde6c694bd45d 100644
--- a/api_docs/kbn_core_notifications_browser_internal.mdx
+++ b/api_docs/kbn_core_notifications_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-internal
title: "@kbn/core-notifications-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-notifications-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser-internal']
---
import kbnCoreNotificationsBrowserInternalObj from './kbn_core_notifications_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_notifications_browser_mocks.mdx b/api_docs/kbn_core_notifications_browser_mocks.mdx
index 96be79552c78e..504c8a1f80a5f 100644
--- a/api_docs/kbn_core_notifications_browser_mocks.mdx
+++ b/api_docs/kbn_core_notifications_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-mocks
title: "@kbn/core-notifications-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-notifications-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser-mocks']
---
import kbnCoreNotificationsBrowserMocksObj from './kbn_core_notifications_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_overlays_browser.mdx b/api_docs/kbn_core_overlays_browser.mdx
index 48f02a823c7ed..90bbe4d12ebef 100644
--- a/api_docs/kbn_core_overlays_browser.mdx
+++ b/api_docs/kbn_core_overlays_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser
title: "@kbn/core-overlays-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-overlays-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser']
---
import kbnCoreOverlaysBrowserObj from './kbn_core_overlays_browser.devdocs.json';
diff --git a/api_docs/kbn_core_overlays_browser_internal.mdx b/api_docs/kbn_core_overlays_browser_internal.mdx
index 098b20707e790..838f4edd8f6df 100644
--- a/api_docs/kbn_core_overlays_browser_internal.mdx
+++ b/api_docs/kbn_core_overlays_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-internal
title: "@kbn/core-overlays-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-overlays-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser-internal']
---
import kbnCoreOverlaysBrowserInternalObj from './kbn_core_overlays_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_overlays_browser_mocks.mdx b/api_docs/kbn_core_overlays_browser_mocks.mdx
index c64c758d6a605..2cbfdf2480666 100644
--- a/api_docs/kbn_core_overlays_browser_mocks.mdx
+++ b/api_docs/kbn_core_overlays_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-mocks
title: "@kbn/core-overlays-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-overlays-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser-mocks']
---
import kbnCoreOverlaysBrowserMocksObj from './kbn_core_overlays_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_plugins_browser.mdx b/api_docs/kbn_core_plugins_browser.mdx
index b92b91f6c1dbe..563a9a98f743a 100644
--- a/api_docs/kbn_core_plugins_browser.mdx
+++ b/api_docs/kbn_core_plugins_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser
title: "@kbn/core-plugins-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-plugins-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser']
---
import kbnCorePluginsBrowserObj from './kbn_core_plugins_browser.devdocs.json';
diff --git a/api_docs/kbn_core_plugins_browser_mocks.mdx b/api_docs/kbn_core_plugins_browser_mocks.mdx
index 744eb08c15994..c0141ecbec359 100644
--- a/api_docs/kbn_core_plugins_browser_mocks.mdx
+++ b/api_docs/kbn_core_plugins_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser-mocks
title: "@kbn/core-plugins-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-plugins-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser-mocks']
---
import kbnCorePluginsBrowserMocksObj from './kbn_core_plugins_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_plugins_contracts_browser.mdx b/api_docs/kbn_core_plugins_contracts_browser.mdx
index 085874cdf51a9..9686c7440aaad 100644
--- a/api_docs/kbn_core_plugins_contracts_browser.mdx
+++ b/api_docs/kbn_core_plugins_contracts_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-contracts-browser
title: "@kbn/core-plugins-contracts-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-plugins-contracts-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-contracts-browser']
---
import kbnCorePluginsContractsBrowserObj from './kbn_core_plugins_contracts_browser.devdocs.json';
diff --git a/api_docs/kbn_core_plugins_contracts_server.mdx b/api_docs/kbn_core_plugins_contracts_server.mdx
index 5c37b94243d8e..97395c287b4fc 100644
--- a/api_docs/kbn_core_plugins_contracts_server.mdx
+++ b/api_docs/kbn_core_plugins_contracts_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-contracts-server
title: "@kbn/core-plugins-contracts-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-plugins-contracts-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-contracts-server']
---
import kbnCorePluginsContractsServerObj from './kbn_core_plugins_contracts_server.devdocs.json';
diff --git a/api_docs/kbn_core_plugins_server.mdx b/api_docs/kbn_core_plugins_server.mdx
index 6f6723ea6844c..6a1d436f62193 100644
--- a/api_docs/kbn_core_plugins_server.mdx
+++ b/api_docs/kbn_core_plugins_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server
title: "@kbn/core-plugins-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-plugins-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-server']
---
import kbnCorePluginsServerObj from './kbn_core_plugins_server.devdocs.json';
diff --git a/api_docs/kbn_core_plugins_server_mocks.mdx b/api_docs/kbn_core_plugins_server_mocks.mdx
index a59bf7e2f3993..c5381e918da47 100644
--- a/api_docs/kbn_core_plugins_server_mocks.mdx
+++ b/api_docs/kbn_core_plugins_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server-mocks
title: "@kbn/core-plugins-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-plugins-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-server-mocks']
---
import kbnCorePluginsServerMocksObj from './kbn_core_plugins_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_preboot_server.mdx b/api_docs/kbn_core_preboot_server.mdx
index 53cdb2a4990bc..332f759dd08a8 100644
--- a/api_docs/kbn_core_preboot_server.mdx
+++ b/api_docs/kbn_core_preboot_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server
title: "@kbn/core-preboot-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-preboot-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server']
---
import kbnCorePrebootServerObj from './kbn_core_preboot_server.devdocs.json';
diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx
index ee61671cedae0..2a017f8eee589 100644
--- a/api_docs/kbn_core_preboot_server_mocks.mdx
+++ b/api_docs/kbn_core_preboot_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server-mocks
title: "@kbn/core-preboot-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-preboot-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server-mocks']
---
import kbnCorePrebootServerMocksObj from './kbn_core_preboot_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_rendering_browser.devdocs.json b/api_docs/kbn_core_rendering_browser.devdocs.json
new file mode 100644
index 0000000000000..0d34673c4efb9
--- /dev/null
+++ b/api_docs/kbn_core_rendering_browser.devdocs.json
@@ -0,0 +1,61 @@
+{
+ "id": "@kbn/core-rendering-browser",
+ "client": {
+ "classes": [],
+ "functions": [
+ {
+ "parentPluginId": "@kbn/core-rendering-browser",
+ "id": "def-public.useAppFixedViewport",
+ "type": "Function",
+ "tags": [],
+ "label": "useAppFixedViewport",
+ "description": [],
+ "signature": [
+ "() => HTMLElement | undefined"
+ ],
+ "path": "packages/core/rendering/core-rendering-browser/src/use_app_fixed_viewport.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [],
+ "returnComment": [],
+ "initialIsOpen": false
+ }
+ ],
+ "interfaces": [],
+ "enums": [],
+ "misc": [
+ {
+ "parentPluginId": "@kbn/core-rendering-browser",
+ "id": "def-public.APP_FIXED_VIEWPORT_ID",
+ "type": "string",
+ "tags": [],
+ "label": "APP_FIXED_VIEWPORT_ID",
+ "description": [],
+ "signature": [
+ "\"app-fixed-viewport\""
+ ],
+ "path": "packages/core/rendering/core-rendering-browser/src/use_app_fixed_viewport.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ }
+ ],
+ "objects": []
+ },
+ "server": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "common": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ }
+}
\ No newline at end of file
diff --git a/api_docs/kbn_core_rendering_browser.mdx b/api_docs/kbn_core_rendering_browser.mdx
new file mode 100644
index 0000000000000..b1fb64d74ea52
--- /dev/null
+++ b/api_docs/kbn_core_rendering_browser.mdx
@@ -0,0 +1,33 @@
+---
+####
+#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
+#### Reach out in #docs-engineering for more info.
+####
+id: kibKbnCoreRenderingBrowserPluginApi
+slug: /kibana-dev-docs/api/kbn-core-rendering-browser
+title: "@kbn/core-rendering-browser"
+image: https://source.unsplash.com/400x175/?github
+description: API docs for the @kbn/core-rendering-browser plugin
+date: 2024-11-19
+tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-browser']
+---
+import kbnCoreRenderingBrowserObj from './kbn_core_rendering_browser.devdocs.json';
+
+
+
+Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
+
+**Code health stats**
+
+| Public API count | Any count | Items lacking comments | Missing exports |
+|-------------------|-----------|------------------------|-----------------|
+| 2 | 0 | 2 | 0 |
+
+## Client
+
+### Functions
+
+
+### Consts, variables and types
+
+
diff --git a/api_docs/kbn_core_rendering_browser_mocks.mdx b/api_docs/kbn_core_rendering_browser_mocks.mdx
index d0bb1f72d98db..ce28fe3fd1eb5 100644
--- a/api_docs/kbn_core_rendering_browser_mocks.mdx
+++ b/api_docs/kbn_core_rendering_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-browser-mocks
title: "@kbn/core-rendering-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-rendering-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-browser-mocks']
---
import kbnCoreRenderingBrowserMocksObj from './kbn_core_rendering_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_rendering_server_internal.mdx b/api_docs/kbn_core_rendering_server_internal.mdx
index e3e140d0bf0da..d37bb4016603d 100644
--- a/api_docs/kbn_core_rendering_server_internal.mdx
+++ b/api_docs/kbn_core_rendering_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-internal
title: "@kbn/core-rendering-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-rendering-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-server-internal']
---
import kbnCoreRenderingServerInternalObj from './kbn_core_rendering_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_rendering_server_mocks.mdx b/api_docs/kbn_core_rendering_server_mocks.mdx
index 8d896ec9668f6..5a5b30ea068cd 100644
--- a/api_docs/kbn_core_rendering_server_mocks.mdx
+++ b/api_docs/kbn_core_rendering_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-mocks
title: "@kbn/core-rendering-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-rendering-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-server-mocks']
---
import kbnCoreRenderingServerMocksObj from './kbn_core_rendering_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_root_server_internal.mdx b/api_docs/kbn_core_root_server_internal.mdx
index 242d0746faa69..6986186c409b0 100644
--- a/api_docs/kbn_core_root_server_internal.mdx
+++ b/api_docs/kbn_core_root_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-root-server-internal
title: "@kbn/core-root-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-root-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-root-server-internal']
---
import kbnCoreRootServerInternalObj from './kbn_core_root_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_api_browser.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx
index 6c33532144e17..e725b2c648a5a 100644
--- a/api_docs/kbn_core_saved_objects_api_browser.mdx
+++ b/api_docs/kbn_core_saved_objects_api_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-browser
title: "@kbn/core-saved-objects-api-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-api-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-browser']
---
import kbnCoreSavedObjectsApiBrowserObj from './kbn_core_saved_objects_api_browser.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_api_server.mdx b/api_docs/kbn_core_saved_objects_api_server.mdx
index a8513ed53bf8f..bd6eecdb721dd 100644
--- a/api_docs/kbn_core_saved_objects_api_server.mdx
+++ b/api_docs/kbn_core_saved_objects_api_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server
title: "@kbn/core-saved-objects-api-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-api-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server']
---
import kbnCoreSavedObjectsApiServerObj from './kbn_core_saved_objects_api_server.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx
index 6c484199eb3fa..68ddf22f343ca 100644
--- a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx
+++ b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server-mocks
title: "@kbn/core-saved-objects-api-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-api-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-mocks']
---
import kbnCoreSavedObjectsApiServerMocksObj from './kbn_core_saved_objects_api_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_base_server_internal.mdx b/api_docs/kbn_core_saved_objects_base_server_internal.mdx
index ae6e8c7a09823..85707a27f7a57 100644
--- a/api_docs/kbn_core_saved_objects_base_server_internal.mdx
+++ b/api_docs/kbn_core_saved_objects_base_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-internal
title: "@kbn/core-saved-objects-base-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-base-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-internal']
---
import kbnCoreSavedObjectsBaseServerInternalObj from './kbn_core_saved_objects_base_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx
index a32054a1f8bfb..77e64c59e27cb 100644
--- a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx
+++ b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-mocks
title: "@kbn/core-saved-objects-base-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-base-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-mocks']
---
import kbnCoreSavedObjectsBaseServerMocksObj from './kbn_core_saved_objects_base_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_browser.mdx b/api_docs/kbn_core_saved_objects_browser.mdx
index 33914f4b0d106..be23263af9827 100644
--- a/api_docs/kbn_core_saved_objects_browser.mdx
+++ b/api_docs/kbn_core_saved_objects_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser
title: "@kbn/core-saved-objects-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser']
---
import kbnCoreSavedObjectsBrowserObj from './kbn_core_saved_objects_browser.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_browser_internal.mdx b/api_docs/kbn_core_saved_objects_browser_internal.mdx
index a526e11fe05c6..42ae9d39e58c9 100644
--- a/api_docs/kbn_core_saved_objects_browser_internal.mdx
+++ b/api_docs/kbn_core_saved_objects_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-internal
title: "@kbn/core-saved-objects-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-internal']
---
import kbnCoreSavedObjectsBrowserInternalObj from './kbn_core_saved_objects_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_browser_mocks.mdx b/api_docs/kbn_core_saved_objects_browser_mocks.mdx
index ae60dcddd2d03..5bfc831e66b52 100644
--- a/api_docs/kbn_core_saved_objects_browser_mocks.mdx
+++ b/api_docs/kbn_core_saved_objects_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-mocks
title: "@kbn/core-saved-objects-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-mocks']
---
import kbnCoreSavedObjectsBrowserMocksObj from './kbn_core_saved_objects_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_common.mdx b/api_docs/kbn_core_saved_objects_common.mdx
index a12a9f3e1db17..e2272be3f5b6a 100644
--- a/api_docs/kbn_core_saved_objects_common.mdx
+++ b/api_docs/kbn_core_saved_objects_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-common
title: "@kbn/core-saved-objects-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-common']
---
import kbnCoreSavedObjectsCommonObj from './kbn_core_saved_objects_common.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx
index cab962776b046..5771d8c5f0cf9 100644
--- a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx
+++ b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-internal
title: "@kbn/core-saved-objects-import-export-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-import-export-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-internal']
---
import kbnCoreSavedObjectsImportExportServerInternalObj from './kbn_core_saved_objects_import_export_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx
index 53b6978fd957f..838de5f7d7d6b 100644
--- a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx
+++ b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-mocks
title: "@kbn/core-saved-objects-import-export-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-import-export-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-mocks']
---
import kbnCoreSavedObjectsImportExportServerMocksObj from './kbn_core_saved_objects_import_export_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx
index f4e36643252c0..dee4e46c8b499 100644
--- a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx
+++ b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-internal
title: "@kbn/core-saved-objects-migration-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-migration-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-internal']
---
import kbnCoreSavedObjectsMigrationServerInternalObj from './kbn_core_saved_objects_migration_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx
index c9a2b8f5950e5..f826fa326cd58 100644
--- a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx
+++ b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-mocks
title: "@kbn/core-saved-objects-migration-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-migration-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-mocks']
---
import kbnCoreSavedObjectsMigrationServerMocksObj from './kbn_core_saved_objects_migration_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_server.mdx b/api_docs/kbn_core_saved_objects_server.mdx
index c7b762a8faf5b..570d16949cd8a 100644
--- a/api_docs/kbn_core_saved_objects_server.mdx
+++ b/api_docs/kbn_core_saved_objects_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server
title: "@kbn/core-saved-objects-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server']
---
import kbnCoreSavedObjectsServerObj from './kbn_core_saved_objects_server.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_server_internal.mdx b/api_docs/kbn_core_saved_objects_server_internal.mdx
index d755588243a97..cd5dd581a7fac 100644
--- a/api_docs/kbn_core_saved_objects_server_internal.mdx
+++ b/api_docs/kbn_core_saved_objects_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-internal
title: "@kbn/core-saved-objects-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server-internal']
---
import kbnCoreSavedObjectsServerInternalObj from './kbn_core_saved_objects_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_server_mocks.mdx b/api_docs/kbn_core_saved_objects_server_mocks.mdx
index 32bb2eef13eb6..1952eaad20966 100644
--- a/api_docs/kbn_core_saved_objects_server_mocks.mdx
+++ b/api_docs/kbn_core_saved_objects_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-mocks
title: "@kbn/core-saved-objects-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server-mocks']
---
import kbnCoreSavedObjectsServerMocksObj from './kbn_core_saved_objects_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_saved_objects_utils_server.mdx b/api_docs/kbn_core_saved_objects_utils_server.mdx
index ecd7bdda7a302..139d216c00776 100644
--- a/api_docs/kbn_core_saved_objects_utils_server.mdx
+++ b/api_docs/kbn_core_saved_objects_utils_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-utils-server
title: "@kbn/core-saved-objects-utils-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-saved-objects-utils-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-utils-server']
---
import kbnCoreSavedObjectsUtilsServerObj from './kbn_core_saved_objects_utils_server.devdocs.json';
diff --git a/api_docs/kbn_core_security_browser.mdx b/api_docs/kbn_core_security_browser.mdx
index 95f3f6c512b85..423aa2d1448e3 100644
--- a/api_docs/kbn_core_security_browser.mdx
+++ b/api_docs/kbn_core_security_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-browser
title: "@kbn/core-security-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-security-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-browser']
---
import kbnCoreSecurityBrowserObj from './kbn_core_security_browser.devdocs.json';
diff --git a/api_docs/kbn_core_security_browser_internal.mdx b/api_docs/kbn_core_security_browser_internal.mdx
index e479360b7c3e6..8c1dea36b8bca 100644
--- a/api_docs/kbn_core_security_browser_internal.mdx
+++ b/api_docs/kbn_core_security_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-browser-internal
title: "@kbn/core-security-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-security-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-browser-internal']
---
import kbnCoreSecurityBrowserInternalObj from './kbn_core_security_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_security_browser_mocks.mdx b/api_docs/kbn_core_security_browser_mocks.mdx
index 45309a65c710b..717621b4bfdb6 100644
--- a/api_docs/kbn_core_security_browser_mocks.mdx
+++ b/api_docs/kbn_core_security_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-browser-mocks
title: "@kbn/core-security-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-security-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-browser-mocks']
---
import kbnCoreSecurityBrowserMocksObj from './kbn_core_security_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_security_common.mdx b/api_docs/kbn_core_security_common.mdx
index 748e4dd3b366d..a128b7a117455 100644
--- a/api_docs/kbn_core_security_common.mdx
+++ b/api_docs/kbn_core_security_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-common
title: "@kbn/core-security-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-security-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-common']
---
import kbnCoreSecurityCommonObj from './kbn_core_security_common.devdocs.json';
diff --git a/api_docs/kbn_core_security_server.mdx b/api_docs/kbn_core_security_server.mdx
index da7c8521f8019..0c269a0727025 100644
--- a/api_docs/kbn_core_security_server.mdx
+++ b/api_docs/kbn_core_security_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-server
title: "@kbn/core-security-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-security-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-server']
---
import kbnCoreSecurityServerObj from './kbn_core_security_server.devdocs.json';
diff --git a/api_docs/kbn_core_security_server_internal.mdx b/api_docs/kbn_core_security_server_internal.mdx
index accfaf5d13407..f8683c2577aa3 100644
--- a/api_docs/kbn_core_security_server_internal.mdx
+++ b/api_docs/kbn_core_security_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-server-internal
title: "@kbn/core-security-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-security-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-server-internal']
---
import kbnCoreSecurityServerInternalObj from './kbn_core_security_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_security_server_mocks.mdx b/api_docs/kbn_core_security_server_mocks.mdx
index 0ebfe736e1669..6fb66f6c06895 100644
--- a/api_docs/kbn_core_security_server_mocks.mdx
+++ b/api_docs/kbn_core_security_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-server-mocks
title: "@kbn/core-security-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-security-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-server-mocks']
---
import kbnCoreSecurityServerMocksObj from './kbn_core_security_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_status_common.devdocs.json b/api_docs/kbn_core_status_common.devdocs.json
index 10cab0bc06263..daaeb4f57c38a 100644
--- a/api_docs/kbn_core_status_common.devdocs.json
+++ b/api_docs/kbn_core_status_common.devdocs.json
@@ -78,6 +78,89 @@
],
"initialIsOpen": false
},
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.ServerVersion",
+ "type": "Interface",
+ "tags": [],
+ "label": "ServerVersion",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.ServerVersion.number",
+ "type": "string",
+ "tags": [],
+ "label": "number",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.ServerVersion.build_hash",
+ "type": "string",
+ "tags": [],
+ "label": "build_hash",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.ServerVersion.build_number",
+ "type": "number",
+ "tags": [],
+ "label": "build_number",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.ServerVersion.build_snapshot",
+ "type": "boolean",
+ "tags": [],
+ "label": "build_snapshot",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.ServerVersion.build_flavor",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "build_flavor",
+ "description": [],
+ "signature": [
+ "\"serverless\" | \"traditional\""
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.ServerVersion.build_date",
+ "type": "string",
+ "tags": [],
+ "label": "build_date",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/core-status-common",
"id": "def-common.ServiceStatus",
@@ -180,10 +263,263 @@
}
],
"initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusInfo",
+ "type": "Interface",
+ "tags": [],
+ "label": "StatusInfo",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusInfo.overall",
+ "type": "Object",
+ "tags": [],
+ "label": "overall",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.StatusInfoServiceStatus",
+ "text": "StatusInfoServiceStatus"
+ }
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusInfo.core",
+ "type": "Object",
+ "tags": [],
+ "label": "core",
+ "description": [],
+ "signature": [
+ "{ elasticsearch: ",
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.StatusInfoServiceStatus",
+ "text": "StatusInfoServiceStatus"
+ },
+ "; savedObjects: ",
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.StatusInfoServiceStatus",
+ "text": "StatusInfoServiceStatus"
+ },
+ "; }"
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusInfo.plugins",
+ "type": "Object",
+ "tags": [],
+ "label": "plugins",
+ "description": [],
+ "signature": [
+ "{ [x: string]: ",
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.StatusInfoServiceStatus",
+ "text": "StatusInfoServiceStatus"
+ },
+ "; }"
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusInfoServiceStatus",
+ "type": "Interface",
+ "tags": [],
+ "label": "StatusInfoServiceStatus",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.StatusInfoServiceStatus",
+ "text": "StatusInfoServiceStatus"
+ },
+ " extends Omit<",
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.ServiceStatus",
+ "text": "ServiceStatus"
+ },
+ ", \"level\">"
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusInfoServiceStatus.level",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "level",
+ "description": [],
+ "signature": [
+ "\"degraded\" | \"unavailable\" | \"available\" | \"critical\""
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusResponse",
+ "type": "Interface",
+ "tags": [],
+ "label": "StatusResponse",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusResponse.name",
+ "type": "string",
+ "tags": [],
+ "label": "name",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusResponse.uuid",
+ "type": "string",
+ "tags": [],
+ "label": "uuid",
+ "description": [],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusResponse.version",
+ "type": "Object",
+ "tags": [],
+ "label": "version",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.ServerVersion",
+ "text": "ServerVersion"
+ }
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusResponse.status",
+ "type": "Object",
+ "tags": [],
+ "label": "status",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.StatusInfo",
+ "text": "StatusInfo"
+ }
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusResponse.metrics",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "metrics",
+ "description": [],
+ "signature": [
+ "Omit<",
+ {
+ "pluginId": "@kbn/core-metrics-server",
+ "scope": "server",
+ "docId": "kibKbnCoreMetricsServerPluginApi",
+ "section": "def-server.OpsMetrics",
+ "text": "OpsMetrics"
+ },
+ ", \"collected_at\"> & { last_updated: string; collection_interval_in_millis: number; requests: { status_codes: Record; }; }"
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
}
],
"enums": [],
"misc": [
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.ServerMetrics",
+ "type": "Type",
+ "tags": [],
+ "label": "ServerMetrics",
+ "description": [],
+ "signature": [
+ "Omit<",
+ {
+ "pluginId": "@kbn/core-metrics-server",
+ "scope": "server",
+ "docId": "kibKbnCoreMetricsServerPluginApi",
+ "section": "def-server.OpsMetrics",
+ "text": "OpsMetrics"
+ },
+ ", \"collected_at\"> & { last_updated: string; collection_interval_in_millis: number; requests: { status_codes: Record; }; }"
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/core-status-common",
"id": "def-common.ServiceStatusLevel",
@@ -217,6 +553,39 @@
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-status-common",
+ "id": "def-common.StatusInfoCoreStatus",
+ "type": "Type",
+ "tags": [],
+ "label": "StatusInfoCoreStatus",
+ "description": [
+ "\nCopy all the services listed in CoreStatus with their specific ServiceStatus declarations\nbut overwriting the `level` to its stringified version."
+ ],
+ "signature": [
+ "{ elasticsearch: ",
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.StatusInfoServiceStatus",
+ "text": "StatusInfoServiceStatus"
+ },
+ "; savedObjects: ",
+ {
+ "pluginId": "@kbn/core-status-common",
+ "scope": "common",
+ "docId": "kibKbnCoreStatusCommonPluginApi",
+ "section": "def-common.StatusInfoServiceStatus",
+ "text": "StatusInfoServiceStatus"
+ },
+ "; }"
+ ],
+ "path": "packages/core/status/core-status-common/src/status.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
}
],
"objects": [
diff --git a/api_docs/kbn_core_status_common.mdx b/api_docs/kbn_core_status_common.mdx
index a5eb49302d75e..fb76669555f16 100644
--- a/api_docs/kbn_core_status_common.mdx
+++ b/api_docs/kbn_core_status_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common
title: "@kbn/core-status-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-status-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common']
---
import kbnCoreStatusCommonObj from './kbn_core_status_common.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 12 | 0 | 2 | 0 |
+| 33 | 0 | 22 | 0 |
## Common
diff --git a/api_docs/kbn_core_status_common_internal.mdx b/api_docs/kbn_core_status_common_internal.mdx
index f9190cacf549a..b0f940662275a 100644
--- a/api_docs/kbn_core_status_common_internal.mdx
+++ b/api_docs/kbn_core_status_common_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common-internal
title: "@kbn/core-status-common-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-status-common-internal plugin
-date: 2024-11-13
+date: 2024-11-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common-internal']
---
import kbnCoreStatusCommonInternalObj from './kbn_core_status_common_internal.devdocs.json';
diff --git a/api_docs/kbn_core_status_server.mdx b/api_docs/kbn_core_status_server.mdx
index 133929233cfb1..7a0eeaaa698ca 100644
--- a/api_docs/kbn_core_status_server.mdx
+++ b/api_docs/kbn_core_status_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server
title: "@kbn/core-status-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-status-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server']
---
import kbnCoreStatusServerObj from './kbn_core_status_server.devdocs.json';
diff --git a/api_docs/kbn_core_status_server_internal.mdx b/api_docs/kbn_core_status_server_internal.mdx
index a46870aec8856..f6d6aa0488ed9 100644
--- a/api_docs/kbn_core_status_server_internal.mdx
+++ b/api_docs/kbn_core_status_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-internal
title: "@kbn/core-status-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-status-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-internal']
---
import kbnCoreStatusServerInternalObj from './kbn_core_status_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_status_server_mocks.mdx b/api_docs/kbn_core_status_server_mocks.mdx
index 86739effae594..f33ab4a5b5375 100644
--- a/api_docs/kbn_core_status_server_mocks.mdx
+++ b/api_docs/kbn_core_status_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-mocks
title: "@kbn/core-status-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-status-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-mocks']
---
import kbnCoreStatusServerMocksObj from './kbn_core_status_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx
index 0f9fc3107f634..8567fc1586ece 100644
--- a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx
+++ b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-deprecations-getters
title: "@kbn/core-test-helpers-deprecations-getters"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-test-helpers-deprecations-getters plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-deprecations-getters']
---
import kbnCoreTestHelpersDeprecationsGettersObj from './kbn_core_test_helpers_deprecations_getters.devdocs.json';
diff --git a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx
index d7cc8a689d698..4e110bb1b7cab 100644
--- a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx
+++ b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-http-setup-browser
title: "@kbn/core-test-helpers-http-setup-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-test-helpers-http-setup-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-http-setup-browser']
---
import kbnCoreTestHelpersHttpSetupBrowserObj from './kbn_core_test_helpers_http_setup_browser.devdocs.json';
diff --git a/api_docs/kbn_core_test_helpers_kbn_server.mdx b/api_docs/kbn_core_test_helpers_kbn_server.mdx
index 78f0bde6b70ec..c6384e292335c 100644
--- a/api_docs/kbn_core_test_helpers_kbn_server.mdx
+++ b/api_docs/kbn_core_test_helpers_kbn_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-kbn-server
title: "@kbn/core-test-helpers-kbn-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-test-helpers-kbn-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-kbn-server']
---
import kbnCoreTestHelpersKbnServerObj from './kbn_core_test_helpers_kbn_server.devdocs.json';
diff --git a/api_docs/kbn_core_test_helpers_model_versions.mdx b/api_docs/kbn_core_test_helpers_model_versions.mdx
index 56e5d559f9712..afffaa34e0a51 100644
--- a/api_docs/kbn_core_test_helpers_model_versions.mdx
+++ b/api_docs/kbn_core_test_helpers_model_versions.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-model-versions
title: "@kbn/core-test-helpers-model-versions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-test-helpers-model-versions plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-model-versions']
---
import kbnCoreTestHelpersModelVersionsObj from './kbn_core_test_helpers_model_versions.devdocs.json';
diff --git a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx
index e4d0764095ead..589aa24b39c65 100644
--- a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx
+++ b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-so-type-serializer
title: "@kbn/core-test-helpers-so-type-serializer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-test-helpers-so-type-serializer plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-so-type-serializer']
---
import kbnCoreTestHelpersSoTypeSerializerObj from './kbn_core_test_helpers_so_type_serializer.devdocs.json';
diff --git a/api_docs/kbn_core_test_helpers_test_utils.mdx b/api_docs/kbn_core_test_helpers_test_utils.mdx
index 9d506f9c5a96c..f79b57c587ad0 100644
--- a/api_docs/kbn_core_test_helpers_test_utils.mdx
+++ b/api_docs/kbn_core_test_helpers_test_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-test-utils
title: "@kbn/core-test-helpers-test-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-test-helpers-test-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-test-utils']
---
import kbnCoreTestHelpersTestUtilsObj from './kbn_core_test_helpers_test_utils.devdocs.json';
diff --git a/api_docs/kbn_core_theme_browser.devdocs.json b/api_docs/kbn_core_theme_browser.devdocs.json
index 532e555e774aa..e3fdeea41634b 100644
--- a/api_docs/kbn_core_theme_browser.devdocs.json
+++ b/api_docs/kbn_core_theme_browser.devdocs.json
@@ -29,6 +29,19 @@
"path": "packages/core/theme/core-theme-browser/src/types.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/core-theme-browser",
+ "id": "def-public.CoreTheme.name",
+ "type": "string",
+ "tags": [],
+ "label": "name",
+ "description": [
+ "\nName of the active theme"
+ ],
+ "path": "packages/core/theme/core-theme-browser/src/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx
index a30c90a383bea..754e0198048c6 100644
--- a/api_docs/kbn_core_theme_browser.mdx
+++ b/api_docs/kbn_core_theme_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser
title: "@kbn/core-theme-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-theme-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser']
---
import kbnCoreThemeBrowserObj from './kbn_core_theme_browser.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 6 | 0 | 2 | 0 |
+| 7 | 0 | 2 | 0 |
## Client
diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx
index 9444011732a8c..6bd750930627a 100644
--- a/api_docs/kbn_core_theme_browser_mocks.mdx
+++ b/api_docs/kbn_core_theme_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks
title: "@kbn/core-theme-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-theme-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks']
---
import kbnCoreThemeBrowserMocksObj from './kbn_core_theme_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_ui_settings_browser.mdx b/api_docs/kbn_core_ui_settings_browser.mdx
index c34718b6f7e72..f4ce185dd9d59 100644
--- a/api_docs/kbn_core_ui_settings_browser.mdx
+++ b/api_docs/kbn_core_ui_settings_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser
title: "@kbn/core-ui-settings-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-ui-settings-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser']
---
import kbnCoreUiSettingsBrowserObj from './kbn_core_ui_settings_browser.devdocs.json';
diff --git a/api_docs/kbn_core_ui_settings_browser_internal.mdx b/api_docs/kbn_core_ui_settings_browser_internal.mdx
index ea4cde0c8f75c..e6db69bc68ed1 100644
--- a/api_docs/kbn_core_ui_settings_browser_internal.mdx
+++ b/api_docs/kbn_core_ui_settings_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-internal
title: "@kbn/core-ui-settings-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-ui-settings-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-internal']
---
import kbnCoreUiSettingsBrowserInternalObj from './kbn_core_ui_settings_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_ui_settings_browser_mocks.mdx b/api_docs/kbn_core_ui_settings_browser_mocks.mdx
index 75b7c7d20b749..3eea8cd886513 100644
--- a/api_docs/kbn_core_ui_settings_browser_mocks.mdx
+++ b/api_docs/kbn_core_ui_settings_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-mocks
title: "@kbn/core-ui-settings-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-ui-settings-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-mocks']
---
import kbnCoreUiSettingsBrowserMocksObj from './kbn_core_ui_settings_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_ui_settings_common.devdocs.json b/api_docs/kbn_core_ui_settings_common.devdocs.json
index 5e1bb26a62417..8c13ce99b607c 100644
--- a/api_docs/kbn_core_ui_settings_common.devdocs.json
+++ b/api_docs/kbn_core_ui_settings_common.devdocs.json
@@ -19,6 +19,53 @@
"common": {
"classes": [],
"functions": [
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.hasNonDefaultThemeTags",
+ "type": "Function",
+ "tags": [],
+ "label": "hasNonDefaultThemeTags",
+ "description": [],
+ "signature": [
+ "(tags: ",
+ {
+ "pluginId": "@kbn/core-ui-settings-common",
+ "scope": "common",
+ "docId": "kibKbnCoreUiSettingsCommonPluginApi",
+ "section": "def-common.ThemeTags",
+ "text": "ThemeTags"
+ },
+ ") => boolean"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.hasNonDefaultThemeTags.$1",
+ "type": "Object",
+ "tags": [],
+ "label": "tags",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "@kbn/core-ui-settings-common",
+ "scope": "common",
+ "docId": "kibKbnCoreUiSettingsCommonPluginApi",
+ "section": "def-common.ThemeTags",
+ "text": "ThemeTags"
+ }
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/core-ui-settings-common",
"id": "def-common.parseDarkModeValue",
@@ -58,6 +105,79 @@
],
"returnComment": [],
"initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.parseThemeNameValue",
+ "type": "Function",
+ "tags": [],
+ "label": "parseThemeNameValue",
+ "description": [],
+ "signature": [
+ "(value: unknown) => string"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.parseThemeNameValue.$1",
+ "type": "Unknown",
+ "tags": [],
+ "label": "value",
+ "description": [],
+ "signature": [
+ "unknown"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.parseThemeTags",
+ "type": "Function",
+ "tags": [],
+ "label": "parseThemeTags",
+ "description": [],
+ "signature": [
+ "(input: unknown) => ",
+ {
+ "pluginId": "@kbn/core-ui-settings-common",
+ "scope": "common",
+ "docId": "kibKbnCoreUiSettingsCommonPluginApi",
+ "section": "def-common.ThemeTags",
+ "text": "ThemeTags"
+ }
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.parseThemeTags.$1",
+ "type": "Unknown",
+ "tags": [],
+ "label": "input",
+ "description": [],
+ "signature": [
+ "unknown"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
}
],
"interfaces": [
@@ -598,6 +718,36 @@
"trackAdoption": false,
"initialIsOpen": false
},
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.DEFAULT_THEME_NAME",
+ "type": "string",
+ "tags": [],
+ "label": "DEFAULT_THEME_NAME",
+ "description": [],
+ "signature": [
+ "\"amsterdam\""
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.FALLBACK_THEME_TAG",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "FALLBACK_THEME_TAG",
+ "description": [],
+ "signature": [
+ "\"v8light\" | \"v8dark\" | \"borealislight\" | \"borealisdark\""
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/core-ui-settings-common",
"id": "def-common.ReadonlyModeType",
@@ -615,6 +765,66 @@
"trackAdoption": false,
"initialIsOpen": false
},
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.SUPPORTED_THEME_NAMES",
+ "type": "Array",
+ "tags": [],
+ "label": "SUPPORTED_THEME_NAMES",
+ "description": [],
+ "signature": [
+ "string[]"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.ThemeName",
+ "type": "Type",
+ "tags": [],
+ "label": "ThemeName",
+ "description": [],
+ "signature": [
+ "string"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.ThemeTag",
+ "type": "Type",
+ "tags": [],
+ "label": "ThemeTag",
+ "description": [],
+ "signature": [
+ "\"v8light\" | \"v8dark\" | \"borealislight\" | \"borealisdark\""
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.ThemeTags",
+ "type": "Type",
+ "tags": [],
+ "label": "ThemeTags",
+ "description": [],
+ "signature": [
+ "readonly (\"v8light\" | \"v8dark\" | \"borealislight\" | \"borealisdark\")[]"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/core-ui-settings-common",
"id": "def-common.TIMEZONE_OPTIONS",
@@ -665,6 +875,41 @@
"initialIsOpen": false
}
],
- "objects": []
+ "objects": [
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.DEFAULT_THEME_TAGS",
+ "type": "Object",
+ "tags": [],
+ "label": "DEFAULT_THEME_TAGS",
+ "description": [
+ "\nAn array of theme tags available in Kibana by default when not customized\nusing KBN_OPTIMIZER_THEMES environment variable."
+ ],
+ "signature": [
+ "readonly (\"v8light\" | \"v8dark\" | \"borealislight\" | \"borealisdark\")[]"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/core-ui-settings-common",
+ "id": "def-common.SUPPORTED_THEME_TAGS",
+ "type": "Object",
+ "tags": [],
+ "label": "SUPPORTED_THEME_TAGS",
+ "description": [
+ "\nAn array of all theme tags supported by Kibana. Note that this list doesn't\nreflect what theme tags are available in a Kibana build."
+ ],
+ "signature": [
+ "readonly [\"v8light\", \"v8dark\", \"borealislight\", \"borealisdark\"]"
+ ],
+ "path": "packages/core/ui-settings/core-ui-settings-common/src/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ }
+ ]
}
}
\ No newline at end of file
diff --git a/api_docs/kbn_core_ui_settings_common.mdx b/api_docs/kbn_core_ui_settings_common.mdx
index c655b1143b2d7..eb756979dc5f6 100644
--- a/api_docs/kbn_core_ui_settings_common.mdx
+++ b/api_docs/kbn_core_ui_settings_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-common
title: "@kbn/core-ui-settings-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-ui-settings-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-common']
---
import kbnCoreUiSettingsCommonObj from './kbn_core_ui_settings_common.devdocs.json';
@@ -21,10 +21,13 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 34 | 0 | 8 | 0 |
+| 48 | 0 | 20 | 0 |
## Common
+### Objects
+
+
### Functions
diff --git a/api_docs/kbn_core_ui_settings_server.mdx b/api_docs/kbn_core_ui_settings_server.mdx
index d0c253d908422..8b8fb11fe1481 100644
--- a/api_docs/kbn_core_ui_settings_server.mdx
+++ b/api_docs/kbn_core_ui_settings_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server
title: "@kbn/core-ui-settings-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-ui-settings-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server']
---
import kbnCoreUiSettingsServerObj from './kbn_core_ui_settings_server.devdocs.json';
diff --git a/api_docs/kbn_core_ui_settings_server_internal.devdocs.json b/api_docs/kbn_core_ui_settings_server_internal.devdocs.json
index f07afb4f2d383..81c2046948901 100644
--- a/api_docs/kbn_core_ui_settings_server_internal.devdocs.json
+++ b/api_docs/kbn_core_ui_settings_server_internal.devdocs.json
@@ -325,7 +325,15 @@
"section": "def-common.ConditionalType",
"text": "ConditionalType"
},
- "; }>"
+ "; experimental: ",
+ {
+ "pluginId": "@kbn/config-schema",
+ "scope": "common",
+ "docId": "kibKbnConfigSchemaPluginApi",
+ "section": "def-common.Type",
+ "text": "Type"
+ },
+ " | undefined>; }>"
],
"path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts",
"deprecated": false,
diff --git a/api_docs/kbn_core_ui_settings_server_internal.mdx b/api_docs/kbn_core_ui_settings_server_internal.mdx
index 070910248a27d..d2f4c1c441c14 100644
--- a/api_docs/kbn_core_ui_settings_server_internal.mdx
+++ b/api_docs/kbn_core_ui_settings_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-internal
title: "@kbn/core-ui-settings-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-ui-settings-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-internal']
---
import kbnCoreUiSettingsServerInternalObj from './kbn_core_ui_settings_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_ui_settings_server_mocks.mdx b/api_docs/kbn_core_ui_settings_server_mocks.mdx
index b7758991bfc78..0d0bc1dcee77a 100644
--- a/api_docs/kbn_core_ui_settings_server_mocks.mdx
+++ b/api_docs/kbn_core_ui_settings_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-mocks
title: "@kbn/core-ui-settings-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-ui-settings-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-mocks']
---
import kbnCoreUiSettingsServerMocksObj from './kbn_core_ui_settings_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_usage_data_server.mdx b/api_docs/kbn_core_usage_data_server.mdx
index c4142735a2f68..00e9e839a0db0 100644
--- a/api_docs/kbn_core_usage_data_server.mdx
+++ b/api_docs/kbn_core_usage_data_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server
title: "@kbn/core-usage-data-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-usage-data-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server']
---
import kbnCoreUsageDataServerObj from './kbn_core_usage_data_server.devdocs.json';
diff --git a/api_docs/kbn_core_usage_data_server_internal.mdx b/api_docs/kbn_core_usage_data_server_internal.mdx
index 27f26df0bb8e7..eabb2f46cb4bd 100644
--- a/api_docs/kbn_core_usage_data_server_internal.mdx
+++ b/api_docs/kbn_core_usage_data_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-internal
title: "@kbn/core-usage-data-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-usage-data-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-internal']
---
import kbnCoreUsageDataServerInternalObj from './kbn_core_usage_data_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_usage_data_server_mocks.mdx b/api_docs/kbn_core_usage_data_server_mocks.mdx
index 51db2696d7d9f..442e71a9f6156 100644
--- a/api_docs/kbn_core_usage_data_server_mocks.mdx
+++ b/api_docs/kbn_core_usage_data_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-mocks
title: "@kbn/core-usage-data-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-usage-data-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-mocks']
---
import kbnCoreUsageDataServerMocksObj from './kbn_core_usage_data_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_user_profile_browser.mdx b/api_docs/kbn_core_user_profile_browser.mdx
index 329304a8de213..fbfe0dceec743 100644
--- a/api_docs/kbn_core_user_profile_browser.mdx
+++ b/api_docs/kbn_core_user_profile_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-browser
title: "@kbn/core-user-profile-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-profile-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-browser']
---
import kbnCoreUserProfileBrowserObj from './kbn_core_user_profile_browser.devdocs.json';
diff --git a/api_docs/kbn_core_user_profile_browser_internal.mdx b/api_docs/kbn_core_user_profile_browser_internal.mdx
index dcc6b3e170650..786cce114571d 100644
--- a/api_docs/kbn_core_user_profile_browser_internal.mdx
+++ b/api_docs/kbn_core_user_profile_browser_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-browser-internal
title: "@kbn/core-user-profile-browser-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-profile-browser-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-browser-internal']
---
import kbnCoreUserProfileBrowserInternalObj from './kbn_core_user_profile_browser_internal.devdocs.json';
diff --git a/api_docs/kbn_core_user_profile_browser_mocks.mdx b/api_docs/kbn_core_user_profile_browser_mocks.mdx
index cc323de9750f9..0a10fa69a0e7b 100644
--- a/api_docs/kbn_core_user_profile_browser_mocks.mdx
+++ b/api_docs/kbn_core_user_profile_browser_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-browser-mocks
title: "@kbn/core-user-profile-browser-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-profile-browser-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-browser-mocks']
---
import kbnCoreUserProfileBrowserMocksObj from './kbn_core_user_profile_browser_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_user_profile_common.mdx b/api_docs/kbn_core_user_profile_common.mdx
index 7079c04add1ab..22b0fb9a7a3aa 100644
--- a/api_docs/kbn_core_user_profile_common.mdx
+++ b/api_docs/kbn_core_user_profile_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-common
title: "@kbn/core-user-profile-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-profile-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-common']
---
import kbnCoreUserProfileCommonObj from './kbn_core_user_profile_common.devdocs.json';
diff --git a/api_docs/kbn_core_user_profile_server.mdx b/api_docs/kbn_core_user_profile_server.mdx
index fe98213a52450..fe5871d447573 100644
--- a/api_docs/kbn_core_user_profile_server.mdx
+++ b/api_docs/kbn_core_user_profile_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-server
title: "@kbn/core-user-profile-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-profile-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-server']
---
import kbnCoreUserProfileServerObj from './kbn_core_user_profile_server.devdocs.json';
diff --git a/api_docs/kbn_core_user_profile_server_internal.mdx b/api_docs/kbn_core_user_profile_server_internal.mdx
index 258a7cb6a96e3..e956c586cb892 100644
--- a/api_docs/kbn_core_user_profile_server_internal.mdx
+++ b/api_docs/kbn_core_user_profile_server_internal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-server-internal
title: "@kbn/core-user-profile-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-profile-server-internal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-server-internal']
---
import kbnCoreUserProfileServerInternalObj from './kbn_core_user_profile_server_internal.devdocs.json';
diff --git a/api_docs/kbn_core_user_profile_server_mocks.mdx b/api_docs/kbn_core_user_profile_server_mocks.mdx
index 4dae288fb7e35..96a0f64e49d3e 100644
--- a/api_docs/kbn_core_user_profile_server_mocks.mdx
+++ b/api_docs/kbn_core_user_profile_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-server-mocks
title: "@kbn/core-user-profile-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-profile-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-server-mocks']
---
import kbnCoreUserProfileServerMocksObj from './kbn_core_user_profile_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_core_user_settings_server.mdx b/api_docs/kbn_core_user_settings_server.mdx
index dc2a596e5cecc..fbe8e741314b1 100644
--- a/api_docs/kbn_core_user_settings_server.mdx
+++ b/api_docs/kbn_core_user_settings_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server
title: "@kbn/core-user-settings-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-settings-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server']
---
import kbnCoreUserSettingsServerObj from './kbn_core_user_settings_server.devdocs.json';
diff --git a/api_docs/kbn_core_user_settings_server_mocks.mdx b/api_docs/kbn_core_user_settings_server_mocks.mdx
index 59a7ae58bdc8d..626052ad5a5f0 100644
--- a/api_docs/kbn_core_user_settings_server_mocks.mdx
+++ b/api_docs/kbn_core_user_settings_server_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server-mocks
title: "@kbn/core-user-settings-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-user-settings-server-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server-mocks']
---
import kbnCoreUserSettingsServerMocksObj from './kbn_core_user_settings_server_mocks.devdocs.json';
diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx
index d8c8953e89132..66dee42f2766e 100644
--- a/api_docs/kbn_crypto.mdx
+++ b/api_docs/kbn_crypto.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto
title: "@kbn/crypto"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/crypto plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto']
---
import kbnCryptoObj from './kbn_crypto.devdocs.json';
diff --git a/api_docs/kbn_crypto_browser.mdx b/api_docs/kbn_crypto_browser.mdx
index 61e0fba647a2f..dee6d1cbe8ac4 100644
--- a/api_docs/kbn_crypto_browser.mdx
+++ b/api_docs/kbn_crypto_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto-browser
title: "@kbn/crypto-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/crypto-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser']
---
import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json';
diff --git a/api_docs/kbn_custom_icons.mdx b/api_docs/kbn_custom_icons.mdx
index aa79889870e73..00758126c0150 100644
--- a/api_docs/kbn_custom_icons.mdx
+++ b/api_docs/kbn_custom_icons.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-custom-icons
title: "@kbn/custom-icons"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/custom-icons plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/custom-icons']
---
import kbnCustomIconsObj from './kbn_custom_icons.devdocs.json';
diff --git a/api_docs/kbn_custom_integrations.mdx b/api_docs/kbn_custom_integrations.mdx
index 4b8af621b1df7..5840b3d7c3138 100644
--- a/api_docs/kbn_custom_integrations.mdx
+++ b/api_docs/kbn_custom_integrations.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-custom-integrations
title: "@kbn/custom-integrations"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/custom-integrations plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/custom-integrations']
---
import kbnCustomIntegrationsObj from './kbn_custom_integrations.devdocs.json';
diff --git a/api_docs/kbn_cypress_config.mdx b/api_docs/kbn_cypress_config.mdx
index 98309e6073460..d0289958b9870 100644
--- a/api_docs/kbn_cypress_config.mdx
+++ b/api_docs/kbn_cypress_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cypress-config
title: "@kbn/cypress-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cypress-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cypress-config']
---
import kbnCypressConfigObj from './kbn_cypress_config.devdocs.json';
diff --git a/api_docs/kbn_data_forge.mdx b/api_docs/kbn_data_forge.mdx
index d835d90805170..042936752b9b2 100644
--- a/api_docs/kbn_data_forge.mdx
+++ b/api_docs/kbn_data_forge.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-forge
title: "@kbn/data-forge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/data-forge plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-forge']
---
import kbnDataForgeObj from './kbn_data_forge.devdocs.json';
diff --git a/api_docs/kbn_data_service.mdx b/api_docs/kbn_data_service.mdx
index eb2c2c1580669..1c7f745b042cc 100644
--- a/api_docs/kbn_data_service.mdx
+++ b/api_docs/kbn_data_service.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-service
title: "@kbn/data-service"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/data-service plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-service']
---
import kbnDataServiceObj from './kbn_data_service.devdocs.json';
diff --git a/api_docs/kbn_data_stream_adapter.mdx b/api_docs/kbn_data_stream_adapter.mdx
index abad7e265b108..026499051bd5b 100644
--- a/api_docs/kbn_data_stream_adapter.mdx
+++ b/api_docs/kbn_data_stream_adapter.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-stream-adapter
title: "@kbn/data-stream-adapter"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/data-stream-adapter plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-stream-adapter']
---
import kbnDataStreamAdapterObj from './kbn_data_stream_adapter.devdocs.json';
diff --git a/api_docs/kbn_data_view_utils.mdx b/api_docs/kbn_data_view_utils.mdx
index cb7d116bc202f..9603d5f66141f 100644
--- a/api_docs/kbn_data_view_utils.mdx
+++ b/api_docs/kbn_data_view_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-view-utils
title: "@kbn/data-view-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/data-view-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-view-utils']
---
import kbnDataViewUtilsObj from './kbn_data_view_utils.devdocs.json';
diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx
index 505906fb31807..f9bbad38c755f 100644
--- a/api_docs/kbn_datemath.mdx
+++ b/api_docs/kbn_datemath.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-datemath
title: "@kbn/datemath"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/datemath plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath']
---
import kbnDatemathObj from './kbn_datemath.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_analytics.mdx b/api_docs/kbn_deeplinks_analytics.mdx
index d8d6a7703ce1c..f53c8e1ea7901 100644
--- a/api_docs/kbn_deeplinks_analytics.mdx
+++ b/api_docs/kbn_deeplinks_analytics.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-analytics
title: "@kbn/deeplinks-analytics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-analytics plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-analytics']
---
import kbnDeeplinksAnalyticsObj from './kbn_deeplinks_analytics.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_devtools.mdx b/api_docs/kbn_deeplinks_devtools.mdx
index 2b0f6199eb795..2baf8b49cc0be 100644
--- a/api_docs/kbn_deeplinks_devtools.mdx
+++ b/api_docs/kbn_deeplinks_devtools.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-devtools
title: "@kbn/deeplinks-devtools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-devtools plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-devtools']
---
import kbnDeeplinksDevtoolsObj from './kbn_deeplinks_devtools.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_fleet.mdx b/api_docs/kbn_deeplinks_fleet.mdx
index 3c4e84e16e95b..c8c699dc2b0e8 100644
--- a/api_docs/kbn_deeplinks_fleet.mdx
+++ b/api_docs/kbn_deeplinks_fleet.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-fleet
title: "@kbn/deeplinks-fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-fleet plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-fleet']
---
import kbnDeeplinksFleetObj from './kbn_deeplinks_fleet.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_management.mdx b/api_docs/kbn_deeplinks_management.mdx
index 3e1b614b3c968..b55655888de0e 100644
--- a/api_docs/kbn_deeplinks_management.mdx
+++ b/api_docs/kbn_deeplinks_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-management
title: "@kbn/deeplinks-management"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-management plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-management']
---
import kbnDeeplinksManagementObj from './kbn_deeplinks_management.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_ml.mdx b/api_docs/kbn_deeplinks_ml.mdx
index 3addcc586b635..cc0dae7862e27 100644
--- a/api_docs/kbn_deeplinks_ml.mdx
+++ b/api_docs/kbn_deeplinks_ml.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-ml
title: "@kbn/deeplinks-ml"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-ml plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-ml']
---
import kbnDeeplinksMlObj from './kbn_deeplinks_ml.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_observability.mdx b/api_docs/kbn_deeplinks_observability.mdx
index 203a494f89c3f..fc8e9e51ccf89 100644
--- a/api_docs/kbn_deeplinks_observability.mdx
+++ b/api_docs/kbn_deeplinks_observability.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-observability
title: "@kbn/deeplinks-observability"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-observability plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-observability']
---
import kbnDeeplinksObservabilityObj from './kbn_deeplinks_observability.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_search.mdx b/api_docs/kbn_deeplinks_search.mdx
index fd36f3e28f288..8434dd2812706 100644
--- a/api_docs/kbn_deeplinks_search.mdx
+++ b/api_docs/kbn_deeplinks_search.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-search
title: "@kbn/deeplinks-search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-search plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-search']
---
import kbnDeeplinksSearchObj from './kbn_deeplinks_search.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_security.mdx b/api_docs/kbn_deeplinks_security.mdx
index cdbcaa8a467ed..c7e5616644dd6 100644
--- a/api_docs/kbn_deeplinks_security.mdx
+++ b/api_docs/kbn_deeplinks_security.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-security
title: "@kbn/deeplinks-security"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-security plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-security']
---
import kbnDeeplinksSecurityObj from './kbn_deeplinks_security.devdocs.json';
diff --git a/api_docs/kbn_deeplinks_shared.mdx b/api_docs/kbn_deeplinks_shared.mdx
index 291341c97f067..678bee03bbb91 100644
--- a/api_docs/kbn_deeplinks_shared.mdx
+++ b/api_docs/kbn_deeplinks_shared.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-shared
title: "@kbn/deeplinks-shared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/deeplinks-shared plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-shared']
---
import kbnDeeplinksSharedObj from './kbn_deeplinks_shared.devdocs.json';
diff --git a/api_docs/kbn_default_nav_analytics.mdx b/api_docs/kbn_default_nav_analytics.mdx
index 4508bc2ec7eb6..e0bd3ffff3e1c 100644
--- a/api_docs/kbn_default_nav_analytics.mdx
+++ b/api_docs/kbn_default_nav_analytics.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-analytics
title: "@kbn/default-nav-analytics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/default-nav-analytics plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-analytics']
---
import kbnDefaultNavAnalyticsObj from './kbn_default_nav_analytics.devdocs.json';
diff --git a/api_docs/kbn_default_nav_devtools.mdx b/api_docs/kbn_default_nav_devtools.mdx
index 03b08337e062a..173c5bdfbb7b8 100644
--- a/api_docs/kbn_default_nav_devtools.mdx
+++ b/api_docs/kbn_default_nav_devtools.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-devtools
title: "@kbn/default-nav-devtools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/default-nav-devtools plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-devtools']
---
import kbnDefaultNavDevtoolsObj from './kbn_default_nav_devtools.devdocs.json';
diff --git a/api_docs/kbn_default_nav_management.mdx b/api_docs/kbn_default_nav_management.mdx
index f94cbe8161c5f..cdeb8f4e5dd50 100644
--- a/api_docs/kbn_default_nav_management.mdx
+++ b/api_docs/kbn_default_nav_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-management
title: "@kbn/default-nav-management"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/default-nav-management plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-management']
---
import kbnDefaultNavManagementObj from './kbn_default_nav_management.devdocs.json';
diff --git a/api_docs/kbn_default_nav_ml.mdx b/api_docs/kbn_default_nav_ml.mdx
index 550dcf00691ef..68b482d6ab786 100644
--- a/api_docs/kbn_default_nav_ml.mdx
+++ b/api_docs/kbn_default_nav_ml.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-ml
title: "@kbn/default-nav-ml"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/default-nav-ml plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-ml']
---
import kbnDefaultNavMlObj from './kbn_default_nav_ml.devdocs.json';
diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx
index afd7dfee589b7..60c1ec6b19158 100644
--- a/api_docs/kbn_dev_cli_errors.mdx
+++ b/api_docs/kbn_dev_cli_errors.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors
title: "@kbn/dev-cli-errors"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/dev-cli-errors plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors']
---
import kbnDevCliErrorsObj from './kbn_dev_cli_errors.devdocs.json';
diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx
index d05753f09892e..a620b04e1cfb3 100644
--- a/api_docs/kbn_dev_cli_runner.mdx
+++ b/api_docs/kbn_dev_cli_runner.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner
title: "@kbn/dev-cli-runner"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/dev-cli-runner plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner']
---
import kbnDevCliRunnerObj from './kbn_dev_cli_runner.devdocs.json';
diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx
index 1990746a80c53..5f919b092faaf 100644
--- a/api_docs/kbn_dev_proc_runner.mdx
+++ b/api_docs/kbn_dev_proc_runner.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner
title: "@kbn/dev-proc-runner"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/dev-proc-runner plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner']
---
import kbnDevProcRunnerObj from './kbn_dev_proc_runner.devdocs.json';
diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx
index 0c1273336979a..987517215fe3c 100644
--- a/api_docs/kbn_dev_utils.mdx
+++ b/api_docs/kbn_dev_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils
title: "@kbn/dev-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/dev-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils']
---
import kbnDevUtilsObj from './kbn_dev_utils.devdocs.json';
diff --git a/api_docs/kbn_discover_contextual_components.mdx b/api_docs/kbn_discover_contextual_components.mdx
index 5655074cdc7f3..6bf0157b91390 100644
--- a/api_docs/kbn_discover_contextual_components.mdx
+++ b/api_docs/kbn_discover_contextual_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-discover-contextual-components
title: "@kbn/discover-contextual-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/discover-contextual-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/discover-contextual-components']
---
import kbnDiscoverContextualComponentsObj from './kbn_discover_contextual_components.devdocs.json';
diff --git a/api_docs/kbn_discover_utils.mdx b/api_docs/kbn_discover_utils.mdx
index 47cccc7863d31..e922477193925 100644
--- a/api_docs/kbn_discover_utils.mdx
+++ b/api_docs/kbn_discover_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-discover-utils
title: "@kbn/discover-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/discover-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/discover-utils']
---
import kbnDiscoverUtilsObj from './kbn_discover_utils.devdocs.json';
diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json
index d5942a032f311..d71ced5558ea4 100644
--- a/api_docs/kbn_doc_links.devdocs.json
+++ b/api_docs/kbn_doc_links.devdocs.json
@@ -543,7 +543,7 @@
"label": "securitySolution",
"description": [],
"signature": [
- "{ readonly aiAssistant: string; readonly artifactControl: string; readonly avcResults: string; readonly trustedApps: string; readonly eventFilters: string; readonly eventMerging: string; readonly blocklist: string; readonly endpointArtifacts: string; readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; linux_deadlock: string; }; readonly packageActionTroubleshooting: { es_connection: string; }; readonly threatIntelInt: string; readonly responseActions: string; readonly configureEndpointIntegrationPolicy: string; readonly exceptions: { value_lists: string; }; readonly privileges: string; readonly manageDetectionRules: string; readonly createDetectionRules: string; readonly createEsqlRuleType: string; readonly ruleUiAdvancedParams: string; readonly entityAnalytics: { readonly riskScorePrerequisites: string; readonly entityRiskScoring: string; readonly assetCriticality: string; }; readonly detectionEngineOverview: string; }"
+ "{ readonly aiAssistant: string; readonly artifactControl: string; readonly avcResults: string; readonly bidirectionalIntegrations: string; readonly trustedApps: string; readonly eventFilters: string; readonly eventMerging: string; readonly blocklist: string; readonly endpointArtifacts: string; readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; linux_deadlock: string; }; readonly packageActionTroubleshooting: { es_connection: string; }; readonly threatIntelInt: string; readonly responseActions: string; readonly configureEndpointIntegrationPolicy: string; readonly exceptions: { value_lists: string; }; readonly privileges: string; readonly manageDetectionRules: string; readonly createDetectionRules: string; readonly createEsqlRuleType: string; readonly ruleUiAdvancedParams: string; readonly entityAnalytics: { readonly riskScorePrerequisites: string; readonly entityRiskScoring: string; readonly assetCriticality: string; }; readonly detectionEngineOverview: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx
index aec8487bd99c6..fd95f1dc1864e 100644
--- a/api_docs/kbn_doc_links.mdx
+++ b/api_docs/kbn_doc_links.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links
title: "@kbn/doc-links"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/doc-links plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links']
---
import kbnDocLinksObj from './kbn_doc_links.devdocs.json';
diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx
index 5e5bdb0340a13..a82ec1c5b5b5e 100644
--- a/api_docs/kbn_docs_utils.mdx
+++ b/api_docs/kbn_docs_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils
title: "@kbn/docs-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/docs-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils']
---
import kbnDocsUtilsObj from './kbn_docs_utils.devdocs.json';
diff --git a/api_docs/kbn_dom_drag_drop.mdx b/api_docs/kbn_dom_drag_drop.mdx
index da76fe0161414..a692eaeeb8483 100644
--- a/api_docs/kbn_dom_drag_drop.mdx
+++ b/api_docs/kbn_dom_drag_drop.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dom-drag-drop
title: "@kbn/dom-drag-drop"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/dom-drag-drop plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dom-drag-drop']
---
import kbnDomDragDropObj from './kbn_dom_drag_drop.devdocs.json';
diff --git a/api_docs/kbn_ebt_tools.mdx b/api_docs/kbn_ebt_tools.mdx
index 2abfaa94c6048..fb665a8c3436f 100644
--- a/api_docs/kbn_ebt_tools.mdx
+++ b/api_docs/kbn_ebt_tools.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ebt-tools
title: "@kbn/ebt-tools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ebt-tools plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ebt-tools']
---
import kbnEbtToolsObj from './kbn_ebt_tools.devdocs.json';
diff --git a/api_docs/kbn_ecs_data_quality_dashboard.mdx b/api_docs/kbn_ecs_data_quality_dashboard.mdx
index 4b8d34d2e7d54..a7626a5ce88e7 100644
--- a/api_docs/kbn_ecs_data_quality_dashboard.mdx
+++ b/api_docs/kbn_ecs_data_quality_dashboard.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs-data-quality-dashboard
title: "@kbn/ecs-data-quality-dashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ecs-data-quality-dashboard plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs-data-quality-dashboard']
---
import kbnEcsDataQualityDashboardObj from './kbn_ecs_data_quality_dashboard.devdocs.json';
diff --git a/api_docs/kbn_elastic_agent_utils.mdx b/api_docs/kbn_elastic_agent_utils.mdx
index 40eeb238b56a5..4a8097be68930 100644
--- a/api_docs/kbn_elastic_agent_utils.mdx
+++ b/api_docs/kbn_elastic_agent_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-elastic-agent-utils
title: "@kbn/elastic-agent-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/elastic-agent-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/elastic-agent-utils']
---
import kbnElasticAgentUtilsObj from './kbn_elastic_agent_utils.devdocs.json';
diff --git a/api_docs/kbn_elastic_assistant.mdx b/api_docs/kbn_elastic_assistant.mdx
index 99cb2972bf22e..3b209a2be792e 100644
--- a/api_docs/kbn_elastic_assistant.mdx
+++ b/api_docs/kbn_elastic_assistant.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-elastic-assistant
title: "@kbn/elastic-assistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/elastic-assistant plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/elastic-assistant']
---
import kbnElasticAssistantObj from './kbn_elastic_assistant.devdocs.json';
diff --git a/api_docs/kbn_elastic_assistant_common.devdocs.json b/api_docs/kbn_elastic_assistant_common.devdocs.json
index 47fac3d1e7809..647e12b251582 100644
--- a/api_docs/kbn_elastic_assistant_common.devdocs.json
+++ b/api_docs/kbn_elastic_assistant_common.devdocs.json
@@ -528,15 +528,7 @@
"\nParses a Bedrock buffer from an array of chunks.\n"
],
"signature": [
- "(chunks: Uint8Array[], logger: ",
- {
- "pluginId": "@kbn/logging",
- "scope": "common",
- "docId": "kibKbnLoggingPluginApi",
- "section": "def-common.Logger",
- "text": "Logger"
- },
- ") => string"
+ "(chunks: Uint8Array[]) => string"
],
"path": "x-pack/packages/kbn-elastic-assistant-common/impl/utils/bedrock.ts",
"deprecated": false,
@@ -558,27 +550,6 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
- },
- {
- "parentPluginId": "@kbn/elastic-assistant-common",
- "id": "def-common.parseBedrockBuffer.$2",
- "type": "Object",
- "tags": [],
- "label": "logger",
- "description": [],
- "signature": [
- {
- "pluginId": "@kbn/logging",
- "scope": "common",
- "docId": "kibKbnLoggingPluginApi",
- "section": "def-common.Logger",
- "text": "Logger"
- }
- ],
- "path": "x-pack/packages/kbn-elastic-assistant-common/impl/utils/bedrock.ts",
- "deprecated": false,
- "trackAdoption": false,
- "isRequired": true
}
],
"returnComment": [
diff --git a/api_docs/kbn_elastic_assistant_common.mdx b/api_docs/kbn_elastic_assistant_common.mdx
index b668198e7b76e..f42536ea17c7d 100644
--- a/api_docs/kbn_elastic_assistant_common.mdx
+++ b/api_docs/kbn_elastic_assistant_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-elastic-assistant-common
title: "@kbn/elastic-assistant-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/elastic-assistant-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/elastic-assistant-common']
---
import kbnElasticAssistantCommonObj from './kbn_elastic_assistant_common.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/security-generative-ai](https://github.com/orgs/elastic/teams/
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 401 | 0 | 370 | 0 |
+| 400 | 0 | 369 | 0 |
## Common
diff --git a/api_docs/kbn_entities_schema.mdx b/api_docs/kbn_entities_schema.mdx
index 4e26c607d2c28..8c69abfd80f53 100644
--- a/api_docs/kbn_entities_schema.mdx
+++ b/api_docs/kbn_entities_schema.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-entities-schema
title: "@kbn/entities-schema"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/entities-schema plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/entities-schema']
---
import kbnEntitiesSchemaObj from './kbn_entities_schema.devdocs.json';
diff --git a/api_docs/kbn_es.mdx b/api_docs/kbn_es.mdx
index f8d3ba8259d4f..6c9c415911c2d 100644
--- a/api_docs/kbn_es.mdx
+++ b/api_docs/kbn_es.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es
title: "@kbn/es"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/es plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es']
---
import kbnEsObj from './kbn_es.devdocs.json';
diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx
index 0b7d5cd3c733a..06145c7ba312f 100644
--- a/api_docs/kbn_es_archiver.mdx
+++ b/api_docs/kbn_es_archiver.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver
title: "@kbn/es-archiver"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/es-archiver plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver']
---
import kbnEsArchiverObj from './kbn_es_archiver.devdocs.json';
diff --git a/api_docs/kbn_es_errors.mdx b/api_docs/kbn_es_errors.mdx
index c43c007cbc676..755cebff3136a 100644
--- a/api_docs/kbn_es_errors.mdx
+++ b/api_docs/kbn_es_errors.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-errors
title: "@kbn/es-errors"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/es-errors plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors']
---
import kbnEsErrorsObj from './kbn_es_errors.devdocs.json';
diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx
index e492e904624ba..ccd0f83dc5d5d 100644
--- a/api_docs/kbn_es_query.mdx
+++ b/api_docs/kbn_es_query.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-query
title: "@kbn/es-query"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/es-query plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query']
---
import kbnEsQueryObj from './kbn_es_query.devdocs.json';
diff --git a/api_docs/kbn_es_types.mdx b/api_docs/kbn_es_types.mdx
index 44d786a91b94a..19458d31a669e 100644
--- a/api_docs/kbn_es_types.mdx
+++ b/api_docs/kbn_es_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-types
title: "@kbn/es-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/es-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-types']
---
import kbnEsTypesObj from './kbn_es_types.devdocs.json';
diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx
index a807133177041..7987bf1bbbab7 100644
--- a/api_docs/kbn_eslint_plugin_imports.mdx
+++ b/api_docs/kbn_eslint_plugin_imports.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports
title: "@kbn/eslint-plugin-imports"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/eslint-plugin-imports plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports']
---
import kbnEslintPluginImportsObj from './kbn_eslint_plugin_imports.devdocs.json';
diff --git a/api_docs/kbn_esql_ast.mdx b/api_docs/kbn_esql_ast.mdx
index eae4542ecd411..13efc684ac7ca 100644
--- a/api_docs/kbn_esql_ast.mdx
+++ b/api_docs/kbn_esql_ast.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-esql-ast
title: "@kbn/esql-ast"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/esql-ast plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/esql-ast']
---
import kbnEsqlAstObj from './kbn_esql_ast.devdocs.json';
diff --git a/api_docs/kbn_esql_editor.mdx b/api_docs/kbn_esql_editor.mdx
index 98f7eb11f5b6d..6bbe12c4b1fb6 100644
--- a/api_docs/kbn_esql_editor.mdx
+++ b/api_docs/kbn_esql_editor.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-esql-editor
title: "@kbn/esql-editor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/esql-editor plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/esql-editor']
---
import kbnEsqlEditorObj from './kbn_esql_editor.devdocs.json';
diff --git a/api_docs/kbn_esql_utils.mdx b/api_docs/kbn_esql_utils.mdx
index 332949d9ddfe9..df33de78cf1d9 100644
--- a/api_docs/kbn_esql_utils.mdx
+++ b/api_docs/kbn_esql_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-esql-utils
title: "@kbn/esql-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/esql-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/esql-utils']
---
import kbnEsqlUtilsObj from './kbn_esql_utils.devdocs.json';
diff --git a/api_docs/kbn_esql_validation_autocomplete.devdocs.json b/api_docs/kbn_esql_validation_autocomplete.devdocs.json
index b0f095fcc852e..f35814c5b2e30 100644
--- a/api_docs/kbn_esql_validation_autocomplete.devdocs.json
+++ b/api_docs/kbn_esql_validation_autocomplete.devdocs.json
@@ -39,7 +39,7 @@
},
", parameterDefinition: { name: string; type: ",
"FunctionParameterType",
- "; optional?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; acceptedValues?: string[] | undefined; literalSuggestions?: string[] | undefined; }, references: ",
+ "; optional?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; fieldsOnly?: boolean | undefined; acceptedValues?: string[] | undefined; literalSuggestions?: string[] | undefined; }, references: ",
"ReferenceMaps",
", parentCommand: string | undefined) => boolean | undefined"
],
@@ -78,7 +78,7 @@
"signature": [
"{ name: string; type: ",
"FunctionParameterType",
- "; optional?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; acceptedValues?: string[] | undefined; literalSuggestions?: string[] | undefined; }"
+ "; optional?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; fieldsOnly?: boolean | undefined; acceptedValues?: string[] | undefined; literalSuggestions?: string[] | undefined; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
@@ -3424,7 +3424,7 @@
"signature": [
"{ params: { name: string; type: ",
"FunctionParameterType",
- "; optional?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; acceptedValues?: string[] | undefined; literalSuggestions?: string[] | undefined; }[]; minParams?: number | undefined; returnType: ",
+ "; optional?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; fieldsOnly?: boolean | undefined; acceptedValues?: string[] | undefined; literalSuggestions?: string[] | undefined; }[]; minParams?: number | undefined; returnType: ",
"FunctionReturnType",
"; }[]"
],
@@ -4050,6 +4050,20 @@
"deprecated": false,
"trackAdoption": false
},
+ {
+ "parentPluginId": "@kbn/esql-validation-autocomplete",
+ "id": "def-common.ValidationErrors.fnUnsupportedAfterCommand",
+ "type": "Object",
+ "tags": [],
+ "label": "fnUnsupportedAfterCommand",
+ "description": [],
+ "signature": [
+ "{ message: string; type: { function: string; command: string; }; }"
+ ],
+ "path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.expectedConstant",
@@ -4147,6 +4161,20 @@
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/esql-validation-autocomplete",
+ "id": "def-common.ValidationErrors.onlyWhereCommandSupported",
+ "type": "Object",
+ "tags": [],
+ "label": "onlyWhereCommandSupported",
+ "description": [],
+ "signature": [
+ "{ message: string; type: { fn: string; }; }"
+ ],
+ "path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
diff --git a/api_docs/kbn_esql_validation_autocomplete.mdx b/api_docs/kbn_esql_validation_autocomplete.mdx
index 0c4a4ef024b5a..aab83dacfe4c6 100644
--- a/api_docs/kbn_esql_validation_autocomplete.mdx
+++ b/api_docs/kbn_esql_validation_autocomplete.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-esql-validation-autocomplete
title: "@kbn/esql-validation-autocomplete"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/esql-validation-autocomplete plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/esql-validation-autocomplete']
---
import kbnEsqlValidationAutocompleteObj from './kbn_esql_validation_autocomplete.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 203 | 0 | 191 | 12 |
+| 205 | 0 | 193 | 12 |
## Common
diff --git a/api_docs/kbn_event_annotation_common.mdx b/api_docs/kbn_event_annotation_common.mdx
index ab478158788ae..530a15ae394ec 100644
--- a/api_docs/kbn_event_annotation_common.mdx
+++ b/api_docs/kbn_event_annotation_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-event-annotation-common
title: "@kbn/event-annotation-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/event-annotation-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/event-annotation-common']
---
import kbnEventAnnotationCommonObj from './kbn_event_annotation_common.devdocs.json';
diff --git a/api_docs/kbn_event_annotation_components.mdx b/api_docs/kbn_event_annotation_components.mdx
index 14ab2a90e9afd..6b99272aca714 100644
--- a/api_docs/kbn_event_annotation_components.mdx
+++ b/api_docs/kbn_event_annotation_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-event-annotation-components
title: "@kbn/event-annotation-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/event-annotation-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/event-annotation-components']
---
import kbnEventAnnotationComponentsObj from './kbn_event_annotation_components.devdocs.json';
diff --git a/api_docs/kbn_expandable_flyout.mdx b/api_docs/kbn_expandable_flyout.mdx
index 31224c52ca807..e85640171fc37 100644
--- a/api_docs/kbn_expandable_flyout.mdx
+++ b/api_docs/kbn_expandable_flyout.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-expandable-flyout
title: "@kbn/expandable-flyout"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/expandable-flyout plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/expandable-flyout']
---
import kbnExpandableFlyoutObj from './kbn_expandable_flyout.devdocs.json';
diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx
index 8058aced64c39..e17596edc6b3d 100644
--- a/api_docs/kbn_field_types.mdx
+++ b/api_docs/kbn_field_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-field-types
title: "@kbn/field-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/field-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types']
---
import kbnFieldTypesObj from './kbn_field_types.devdocs.json';
diff --git a/api_docs/kbn_field_utils.mdx b/api_docs/kbn_field_utils.mdx
index 8be9bab1f014c..bdd432f47b048 100644
--- a/api_docs/kbn_field_utils.mdx
+++ b/api_docs/kbn_field_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-field-utils
title: "@kbn/field-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/field-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-utils']
---
import kbnFieldUtilsObj from './kbn_field_utils.devdocs.json';
diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx
index 7927b13addd22..841ba70daf87b 100644
--- a/api_docs/kbn_find_used_node_modules.mdx
+++ b/api_docs/kbn_find_used_node_modules.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules
title: "@kbn/find-used-node-modules"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/find-used-node-modules plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules']
---
import kbnFindUsedNodeModulesObj from './kbn_find_used_node_modules.devdocs.json';
diff --git a/api_docs/kbn_formatters.mdx b/api_docs/kbn_formatters.mdx
index 695b736cab1dd..1e914935970e3 100644
--- a/api_docs/kbn_formatters.mdx
+++ b/api_docs/kbn_formatters.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-formatters
title: "@kbn/formatters"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/formatters plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/formatters']
---
import kbnFormattersObj from './kbn_formatters.devdocs.json';
diff --git a/api_docs/kbn_ftr_common_functional_services.mdx b/api_docs/kbn_ftr_common_functional_services.mdx
index 068957db2f333..605edf5d45601 100644
--- a/api_docs/kbn_ftr_common_functional_services.mdx
+++ b/api_docs/kbn_ftr_common_functional_services.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ftr-common-functional-services
title: "@kbn/ftr-common-functional-services"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ftr-common-functional-services plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ftr-common-functional-services']
---
import kbnFtrCommonFunctionalServicesObj from './kbn_ftr_common_functional_services.devdocs.json';
diff --git a/api_docs/kbn_ftr_common_functional_ui_services.mdx b/api_docs/kbn_ftr_common_functional_ui_services.mdx
index e827d3e34b5aa..81c5b11c9efd6 100644
--- a/api_docs/kbn_ftr_common_functional_ui_services.mdx
+++ b/api_docs/kbn_ftr_common_functional_ui_services.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ftr-common-functional-ui-services
title: "@kbn/ftr-common-functional-ui-services"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ftr-common-functional-ui-services plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ftr-common-functional-ui-services']
---
import kbnFtrCommonFunctionalUiServicesObj from './kbn_ftr_common_functional_ui_services.devdocs.json';
diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx
index 849b002d008fd..ce2c60c2a5f4f 100644
--- a/api_docs/kbn_generate.mdx
+++ b/api_docs/kbn_generate.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate
title: "@kbn/generate"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/generate plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate']
---
import kbnGenerateObj from './kbn_generate.devdocs.json';
diff --git a/api_docs/kbn_generate_console_definitions.mdx b/api_docs/kbn_generate_console_definitions.mdx
index 9c280bf1d873f..659df6b6d540e 100644
--- a/api_docs/kbn_generate_console_definitions.mdx
+++ b/api_docs/kbn_generate_console_definitions.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-console-definitions
title: "@kbn/generate-console-definitions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/generate-console-definitions plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-console-definitions']
---
import kbnGenerateConsoleDefinitionsObj from './kbn_generate_console_definitions.devdocs.json';
diff --git a/api_docs/kbn_generate_csv.mdx b/api_docs/kbn_generate_csv.mdx
index d62324ee3e58d..00cf265caa547 100644
--- a/api_docs/kbn_generate_csv.mdx
+++ b/api_docs/kbn_generate_csv.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-csv
title: "@kbn/generate-csv"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/generate-csv plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-csv']
---
import kbnGenerateCsvObj from './kbn_generate_csv.devdocs.json';
diff --git a/api_docs/kbn_grid_layout.mdx b/api_docs/kbn_grid_layout.mdx
index 5fa4f578eb642..d92d1f03133bf 100644
--- a/api_docs/kbn_grid_layout.mdx
+++ b/api_docs/kbn_grid_layout.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-grid-layout
title: "@kbn/grid-layout"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/grid-layout plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/grid-layout']
---
import kbnGridLayoutObj from './kbn_grid_layout.devdocs.json';
diff --git a/api_docs/kbn_grouping.mdx b/api_docs/kbn_grouping.mdx
index ed22a8bca5b71..849a9e6d7c09c 100644
--- a/api_docs/kbn_grouping.mdx
+++ b/api_docs/kbn_grouping.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-grouping
title: "@kbn/grouping"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/grouping plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/grouping']
---
import kbnGroupingObj from './kbn_grouping.devdocs.json';
diff --git a/api_docs/kbn_guided_onboarding.mdx b/api_docs/kbn_guided_onboarding.mdx
index d1d16c4fac59a..eb1676d34ed0a 100644
--- a/api_docs/kbn_guided_onboarding.mdx
+++ b/api_docs/kbn_guided_onboarding.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-guided-onboarding
title: "@kbn/guided-onboarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/guided-onboarding plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/guided-onboarding']
---
import kbnGuidedOnboardingObj from './kbn_guided_onboarding.devdocs.json';
diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx
index eb2454c7edb08..3792f9f266a08 100644
--- a/api_docs/kbn_handlebars.mdx
+++ b/api_docs/kbn_handlebars.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars
title: "@kbn/handlebars"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/handlebars plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars']
---
import kbnHandlebarsObj from './kbn_handlebars.devdocs.json';
diff --git a/api_docs/kbn_hapi_mocks.mdx b/api_docs/kbn_hapi_mocks.mdx
index a43e5f92bb355..d1f9de4058f5d 100644
--- a/api_docs/kbn_hapi_mocks.mdx
+++ b/api_docs/kbn_hapi_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-hapi-mocks
title: "@kbn/hapi-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/hapi-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/hapi-mocks']
---
import kbnHapiMocksObj from './kbn_hapi_mocks.devdocs.json';
diff --git a/api_docs/kbn_health_gateway_server.mdx b/api_docs/kbn_health_gateway_server.mdx
index c6b230422fbcd..f6c5ed5cbc04d 100644
--- a/api_docs/kbn_health_gateway_server.mdx
+++ b/api_docs/kbn_health_gateway_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-health-gateway-server
title: "@kbn/health-gateway-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/health-gateway-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/health-gateway-server']
---
import kbnHealthGatewayServerObj from './kbn_health_gateway_server.devdocs.json';
diff --git a/api_docs/kbn_home_sample_data_card.mdx b/api_docs/kbn_home_sample_data_card.mdx
index 5b8c6fd706699..e6df5ff079ec4 100644
--- a/api_docs/kbn_home_sample_data_card.mdx
+++ b/api_docs/kbn_home_sample_data_card.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-card
title: "@kbn/home-sample-data-card"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/home-sample-data-card plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-card']
---
import kbnHomeSampleDataCardObj from './kbn_home_sample_data_card.devdocs.json';
diff --git a/api_docs/kbn_home_sample_data_tab.mdx b/api_docs/kbn_home_sample_data_tab.mdx
index 5d002dcf2eb42..b60c354d6619d 100644
--- a/api_docs/kbn_home_sample_data_tab.mdx
+++ b/api_docs/kbn_home_sample_data_tab.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-tab
title: "@kbn/home-sample-data-tab"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/home-sample-data-tab plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-tab']
---
import kbnHomeSampleDataTabObj from './kbn_home_sample_data_tab.devdocs.json';
diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx
index acca86610f39e..a4be4f0677a82 100644
--- a/api_docs/kbn_i18n.mdx
+++ b/api_docs/kbn_i18n.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n
title: "@kbn/i18n"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/i18n plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n']
---
import kbnI18nObj from './kbn_i18n.devdocs.json';
diff --git a/api_docs/kbn_i18n_react.mdx b/api_docs/kbn_i18n_react.mdx
index 278e1db7541ab..8ea07e0ee09dc 100644
--- a/api_docs/kbn_i18n_react.mdx
+++ b/api_docs/kbn_i18n_react.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n-react
title: "@kbn/i18n-react"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/i18n-react plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n-react']
---
import kbnI18nReactObj from './kbn_i18n_react.devdocs.json';
diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx
index 7cdc24b2c9bc1..c0f1d4b97bf7d 100644
--- a/api_docs/kbn_import_resolver.mdx
+++ b/api_docs/kbn_import_resolver.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver
title: "@kbn/import-resolver"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/import-resolver plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver']
---
import kbnImportResolverObj from './kbn_import_resolver.devdocs.json';
diff --git a/api_docs/kbn_index_adapter.mdx b/api_docs/kbn_index_adapter.mdx
index eb276f01b494a..2be722d9e4758 100644
--- a/api_docs/kbn_index_adapter.mdx
+++ b/api_docs/kbn_index_adapter.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-index-adapter
title: "@kbn/index-adapter"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/index-adapter plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/index-adapter']
---
import kbnIndexAdapterObj from './kbn_index_adapter.devdocs.json';
diff --git a/api_docs/kbn_index_lifecycle_management_common_shared.mdx b/api_docs/kbn_index_lifecycle_management_common_shared.mdx
index 9f919868f139a..acd4f2dc9de42 100644
--- a/api_docs/kbn_index_lifecycle_management_common_shared.mdx
+++ b/api_docs/kbn_index_lifecycle_management_common_shared.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-index-lifecycle-management-common-shared
title: "@kbn/index-lifecycle-management-common-shared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/index-lifecycle-management-common-shared plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/index-lifecycle-management-common-shared']
---
import kbnIndexLifecycleManagementCommonSharedObj from './kbn_index_lifecycle_management_common_shared.devdocs.json';
diff --git a/api_docs/kbn_index_management_shared_types.devdocs.json b/api_docs/kbn_index_management_shared_types.devdocs.json
index 34b0baa513dcf..e1db60365e06f 100644
--- a/api_docs/kbn_index_management_shared_types.devdocs.json
+++ b/api_docs/kbn_index_management_shared_types.devdocs.json
@@ -1602,6 +1602,20 @@
"path": "x-pack/packages/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/index-management-shared-types",
+ "id": "def-common.IndexMappingProps.hasUpdateMappingsPrivilege",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "hasUpdateMappingsPrivilege",
+ "description": [],
+ "signature": [
+ "boolean | undefined"
+ ],
+ "path": "x-pack/packages/index-management/index_management_shared_types/src/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
@@ -1627,6 +1641,20 @@
"path": "x-pack/packages/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/index-management-shared-types",
+ "id": "def-common.IndexSettingProps.hasUpdateSettingsPrivilege",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "hasUpdateSettingsPrivilege",
+ "description": [],
+ "signature": [
+ "boolean | undefined"
+ ],
+ "path": "x-pack/packages/index-management/index_management_shared_types/src/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
diff --git a/api_docs/kbn_index_management_shared_types.mdx b/api_docs/kbn_index_management_shared_types.mdx
index 838a46cd07edf..bb926e7aff8cc 100644
--- a/api_docs/kbn_index_management_shared_types.mdx
+++ b/api_docs/kbn_index_management_shared_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-index-management-shared-types
title: "@kbn/index-management-shared-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/index-management-shared-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/index-management-shared-types']
---
import kbnIndexManagementSharedTypesObj from './kbn_index_management_shared_types.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kiban
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 124 | 3 | 124 | 0 |
+| 126 | 3 | 126 | 0 |
## Common
diff --git a/api_docs/kbn_inference_common.devdocs.json b/api_docs/kbn_inference_common.devdocs.json
index f52a08c1b3907..e087e53be14e1 100644
--- a/api_docs/kbn_inference_common.devdocs.json
+++ b/api_docs/kbn_inference_common.devdocs.json
@@ -810,6 +810,54 @@
"returnComment": [],
"initialIsOpen": false
},
+ {
+ "parentPluginId": "@kbn/inference-common",
+ "id": "def-common.truncateList",
+ "type": "Function",
+ "tags": [],
+ "label": "truncateList",
+ "description": [],
+ "signature": [
+ "(values: T[], limit: number) => (string | T)[]"
+ ],
+ "path": "x-pack/packages/ai-infra/inference-common/src/truncate_list.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/inference-common",
+ "id": "def-common.truncateList.$1",
+ "type": "Array",
+ "tags": [],
+ "label": "values",
+ "description": [],
+ "signature": [
+ "T[]"
+ ],
+ "path": "x-pack/packages/ai-infra/inference-common/src/truncate_list.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ },
+ {
+ "parentPluginId": "@kbn/inference-common",
+ "id": "def-common.truncateList.$2",
+ "type": "number",
+ "tags": [],
+ "label": "limit",
+ "description": [],
+ "signature": [
+ "number"
+ ],
+ "path": "x-pack/packages/ai-infra/inference-common/src/truncate_list.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.withoutChunkEvents",
diff --git a/api_docs/kbn_inference_common.mdx b/api_docs/kbn_inference_common.mdx
index 7b92a2539db1b..329bd362de0ed 100644
--- a/api_docs/kbn_inference_common.mdx
+++ b/api_docs/kbn_inference_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-inference-common
title: "@kbn/inference-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/inference-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/inference-common']
---
import kbnInferenceCommonObj from './kbn_inference_common.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/appex-ai-infra](https://github.com/orgs/elastic/teams/appex-ai
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 121 | 0 | 38 | 1 |
+| 124 | 0 | 41 | 1 |
## Common
diff --git a/api_docs/kbn_inference_integration_flyout.mdx b/api_docs/kbn_inference_integration_flyout.mdx
index 185d8c958bb7e..ec3c5b50696cb 100644
--- a/api_docs/kbn_inference_integration_flyout.mdx
+++ b/api_docs/kbn_inference_integration_flyout.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-inference_integration_flyout
title: "@kbn/inference_integration_flyout"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/inference_integration_flyout plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/inference_integration_flyout']
---
import kbnInferenceIntegrationFlyoutObj from './kbn_inference_integration_flyout.devdocs.json';
diff --git a/api_docs/kbn_infra_forge.mdx b/api_docs/kbn_infra_forge.mdx
index 872b35480e27e..773270fbaede0 100644
--- a/api_docs/kbn_infra_forge.mdx
+++ b/api_docs/kbn_infra_forge.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-infra-forge
title: "@kbn/infra-forge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/infra-forge plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/infra-forge']
---
import kbnInfraForgeObj from './kbn_infra_forge.devdocs.json';
diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx
index b2a28f58191e6..96a376405f214 100644
--- a/api_docs/kbn_interpreter.mdx
+++ b/api_docs/kbn_interpreter.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter
title: "@kbn/interpreter"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/interpreter plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter']
---
import kbnInterpreterObj from './kbn_interpreter.devdocs.json';
diff --git a/api_docs/kbn_investigation_shared.mdx b/api_docs/kbn_investigation_shared.mdx
index 5b9daf9c51241..8dd6387e9fcbf 100644
--- a/api_docs/kbn_investigation_shared.mdx
+++ b/api_docs/kbn_investigation_shared.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-investigation-shared
title: "@kbn/investigation-shared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/investigation-shared plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/investigation-shared']
---
import kbnInvestigationSharedObj from './kbn_investigation_shared.devdocs.json';
diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx
index 9644796d64a79..626b407eb2f83 100644
--- a/api_docs/kbn_io_ts_utils.mdx
+++ b/api_docs/kbn_io_ts_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils
title: "@kbn/io-ts-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/io-ts-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils']
---
import kbnIoTsUtilsObj from './kbn_io_ts_utils.devdocs.json';
diff --git a/api_docs/kbn_ipynb.mdx b/api_docs/kbn_ipynb.mdx
index 9950dc2b2d68d..6d96ad4512742 100644
--- a/api_docs/kbn_ipynb.mdx
+++ b/api_docs/kbn_ipynb.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ipynb
title: "@kbn/ipynb"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ipynb plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ipynb']
---
import kbnIpynbObj from './kbn_ipynb.devdocs.json';
diff --git a/api_docs/kbn_item_buffer.mdx b/api_docs/kbn_item_buffer.mdx
index 02e157c9d49f5..f0696724c4cba 100644
--- a/api_docs/kbn_item_buffer.mdx
+++ b/api_docs/kbn_item_buffer.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-item-buffer
title: "@kbn/item-buffer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/item-buffer plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/item-buffer']
---
import kbnItemBufferObj from './kbn_item_buffer.devdocs.json';
diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx
index 29ef5481ebcad..d758caef8530f 100644
--- a/api_docs/kbn_jest_serializers.mdx
+++ b/api_docs/kbn_jest_serializers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers
title: "@kbn/jest-serializers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/jest-serializers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers']
---
import kbnJestSerializersObj from './kbn_jest_serializers.devdocs.json';
diff --git a/api_docs/kbn_journeys.mdx b/api_docs/kbn_journeys.mdx
index 1ed219682fe0d..1844df77977ae 100644
--- a/api_docs/kbn_journeys.mdx
+++ b/api_docs/kbn_journeys.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-journeys
title: "@kbn/journeys"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/journeys plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/journeys']
---
import kbnJourneysObj from './kbn_journeys.devdocs.json';
diff --git a/api_docs/kbn_json_ast.mdx b/api_docs/kbn_json_ast.mdx
index be1230f6021ba..fc7747e45458a 100644
--- a/api_docs/kbn_json_ast.mdx
+++ b/api_docs/kbn_json_ast.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-json-ast
title: "@kbn/json-ast"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/json-ast plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/json-ast']
---
import kbnJsonAstObj from './kbn_json_ast.devdocs.json';
diff --git a/api_docs/kbn_json_schemas.mdx b/api_docs/kbn_json_schemas.mdx
index 6909a6059f904..32b2a18a9ad31 100644
--- a/api_docs/kbn_json_schemas.mdx
+++ b/api_docs/kbn_json_schemas.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-json-schemas
title: "@kbn/json-schemas"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/json-schemas plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/json-schemas']
---
import kbnJsonSchemasObj from './kbn_json_schemas.devdocs.json';
diff --git a/api_docs/kbn_kibana_manifest_schema.mdx b/api_docs/kbn_kibana_manifest_schema.mdx
index 5835995833201..8014e287a5ee7 100644
--- a/api_docs/kbn_kibana_manifest_schema.mdx
+++ b/api_docs/kbn_kibana_manifest_schema.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-manifest-schema
title: "@kbn/kibana-manifest-schema"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/kibana-manifest-schema plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-manifest-schema']
---
import kbnKibanaManifestSchemaObj from './kbn_kibana_manifest_schema.devdocs.json';
diff --git a/api_docs/kbn_language_documentation.mdx b/api_docs/kbn_language_documentation.mdx
index 8764ab991be53..0c3017f7206d0 100644
--- a/api_docs/kbn_language_documentation.mdx
+++ b/api_docs/kbn_language_documentation.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-language-documentation
title: "@kbn/language-documentation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/language-documentation plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/language-documentation']
---
import kbnLanguageDocumentationObj from './kbn_language_documentation.devdocs.json';
diff --git a/api_docs/kbn_lens_embeddable_utils.mdx b/api_docs/kbn_lens_embeddable_utils.mdx
index 4d4dc62fab629..dc8b058d520f6 100644
--- a/api_docs/kbn_lens_embeddable_utils.mdx
+++ b/api_docs/kbn_lens_embeddable_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-lens-embeddable-utils
title: "@kbn/lens-embeddable-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/lens-embeddable-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/lens-embeddable-utils']
---
import kbnLensEmbeddableUtilsObj from './kbn_lens_embeddable_utils.devdocs.json';
diff --git a/api_docs/kbn_lens_formula_docs.mdx b/api_docs/kbn_lens_formula_docs.mdx
index 45ef8c6ff7c84..0b857c511bc78 100644
--- a/api_docs/kbn_lens_formula_docs.mdx
+++ b/api_docs/kbn_lens_formula_docs.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-lens-formula-docs
title: "@kbn/lens-formula-docs"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/lens-formula-docs plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/lens-formula-docs']
---
import kbnLensFormulaDocsObj from './kbn_lens_formula_docs.devdocs.json';
diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx
index 473d230b0daaa..fa34390905109 100644
--- a/api_docs/kbn_logging.mdx
+++ b/api_docs/kbn_logging.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging
title: "@kbn/logging"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/logging plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging']
---
import kbnLoggingObj from './kbn_logging.devdocs.json';
diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx
index 5d3b8b0204fb7..c5b45e8b4fe31 100644
--- a/api_docs/kbn_logging_mocks.mdx
+++ b/api_docs/kbn_logging_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks
title: "@kbn/logging-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/logging-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks']
---
import kbnLoggingMocksObj from './kbn_logging_mocks.devdocs.json';
diff --git a/api_docs/kbn_managed_content_badge.mdx b/api_docs/kbn_managed_content_badge.mdx
index 3e0190d62706c..d2ec98f1c0595 100644
--- a/api_docs/kbn_managed_content_badge.mdx
+++ b/api_docs/kbn_managed_content_badge.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-managed-content-badge
title: "@kbn/managed-content-badge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/managed-content-badge plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/managed-content-badge']
---
import kbnManagedContentBadgeObj from './kbn_managed_content_badge.devdocs.json';
diff --git a/api_docs/kbn_managed_vscode_config.mdx b/api_docs/kbn_managed_vscode_config.mdx
index f86a747a6599b..cf5a7aa80ff98 100644
--- a/api_docs/kbn_managed_vscode_config.mdx
+++ b/api_docs/kbn_managed_vscode_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-managed-vscode-config
title: "@kbn/managed-vscode-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/managed-vscode-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/managed-vscode-config']
---
import kbnManagedVscodeConfigObj from './kbn_managed_vscode_config.devdocs.json';
diff --git a/api_docs/kbn_management_cards_navigation.mdx b/api_docs/kbn_management_cards_navigation.mdx
index a8421f641e128..8dc29d6d64620 100644
--- a/api_docs/kbn_management_cards_navigation.mdx
+++ b/api_docs/kbn_management_cards_navigation.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-cards-navigation
title: "@kbn/management-cards-navigation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-cards-navigation plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-cards-navigation']
---
import kbnManagementCardsNavigationObj from './kbn_management_cards_navigation.devdocs.json';
diff --git a/api_docs/kbn_management_settings_application.mdx b/api_docs/kbn_management_settings_application.mdx
index a2c7ae70015a7..a481c4bc7eabb 100644
--- a/api_docs/kbn_management_settings_application.mdx
+++ b/api_docs/kbn_management_settings_application.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-application
title: "@kbn/management-settings-application"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-application plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-application']
---
import kbnManagementSettingsApplicationObj from './kbn_management_settings_application.devdocs.json';
diff --git a/api_docs/kbn_management_settings_components_field_category.mdx b/api_docs/kbn_management_settings_components_field_category.mdx
index 5a1845e20a69e..77d5e01b3b62d 100644
--- a/api_docs/kbn_management_settings_components_field_category.mdx
+++ b/api_docs/kbn_management_settings_components_field_category.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-components-field-category
title: "@kbn/management-settings-components-field-category"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-components-field-category plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-components-field-category']
---
import kbnManagementSettingsComponentsFieldCategoryObj from './kbn_management_settings_components_field_category.devdocs.json';
diff --git a/api_docs/kbn_management_settings_components_field_input.mdx b/api_docs/kbn_management_settings_components_field_input.mdx
index 23586dd7ddaaa..8052d75a031cd 100644
--- a/api_docs/kbn_management_settings_components_field_input.mdx
+++ b/api_docs/kbn_management_settings_components_field_input.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-components-field-input
title: "@kbn/management-settings-components-field-input"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-components-field-input plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-components-field-input']
---
import kbnManagementSettingsComponentsFieldInputObj from './kbn_management_settings_components_field_input.devdocs.json';
diff --git a/api_docs/kbn_management_settings_components_field_row.mdx b/api_docs/kbn_management_settings_components_field_row.mdx
index e4239cac1b249..68aad3978bd14 100644
--- a/api_docs/kbn_management_settings_components_field_row.mdx
+++ b/api_docs/kbn_management_settings_components_field_row.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-components-field-row
title: "@kbn/management-settings-components-field-row"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-components-field-row plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-components-field-row']
---
import kbnManagementSettingsComponentsFieldRowObj from './kbn_management_settings_components_field_row.devdocs.json';
diff --git a/api_docs/kbn_management_settings_components_form.mdx b/api_docs/kbn_management_settings_components_form.mdx
index 29a7f3487cd25..63afd2efda9c1 100644
--- a/api_docs/kbn_management_settings_components_form.mdx
+++ b/api_docs/kbn_management_settings_components_form.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-components-form
title: "@kbn/management-settings-components-form"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-components-form plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-components-form']
---
import kbnManagementSettingsComponentsFormObj from './kbn_management_settings_components_form.devdocs.json';
diff --git a/api_docs/kbn_management_settings_field_definition.mdx b/api_docs/kbn_management_settings_field_definition.mdx
index a28d46c4fda21..4435445037419 100644
--- a/api_docs/kbn_management_settings_field_definition.mdx
+++ b/api_docs/kbn_management_settings_field_definition.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-field-definition
title: "@kbn/management-settings-field-definition"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-field-definition plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-field-definition']
---
import kbnManagementSettingsFieldDefinitionObj from './kbn_management_settings_field_definition.devdocs.json';
diff --git a/api_docs/kbn_management_settings_ids.devdocs.json b/api_docs/kbn_management_settings_ids.devdocs.json
index bc654d267378b..f46ff2faa9694 100644
--- a/api_docs/kbn_management_settings_ids.devdocs.json
+++ b/api_docs/kbn_management_settings_ids.devdocs.json
@@ -1869,6 +1869,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
+ {
+ "parentPluginId": "@kbn/management-settings-ids",
+ "id": "def-common.THEME_NAME_ID",
+ "type": "string",
+ "tags": [],
+ "label": "THEME_NAME_ID",
+ "description": [],
+ "signature": [
+ "\"theme:name\""
+ ],
+ "path": "packages/kbn-management/settings/setting_ids/index.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/management-settings-ids",
"id": "def-common.TIMELION_ES_DEFAULT_INDEX_ID",
diff --git a/api_docs/kbn_management_settings_ids.mdx b/api_docs/kbn_management_settings_ids.mdx
index abccc5d9baa99..eb7a6fbf0dbd8 100644
--- a/api_docs/kbn_management_settings_ids.mdx
+++ b/api_docs/kbn_management_settings_ids.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-ids
title: "@kbn/management-settings-ids"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-ids plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-ids']
---
import kbnManagementSettingsIdsObj from './kbn_management_settings_ids.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux @elastic/kibana-management](https://github.com/
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 139 | 0 | 138 | 0 |
+| 140 | 0 | 139 | 0 |
## Common
diff --git a/api_docs/kbn_management_settings_section_registry.mdx b/api_docs/kbn_management_settings_section_registry.mdx
index 4ebee73d69cc1..063e5bc3799c8 100644
--- a/api_docs/kbn_management_settings_section_registry.mdx
+++ b/api_docs/kbn_management_settings_section_registry.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-section-registry
title: "@kbn/management-settings-section-registry"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-section-registry plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-section-registry']
---
import kbnManagementSettingsSectionRegistryObj from './kbn_management_settings_section_registry.devdocs.json';
diff --git a/api_docs/kbn_management_settings_types.mdx b/api_docs/kbn_management_settings_types.mdx
index 8e357e653c115..e2cfd0ac56378 100644
--- a/api_docs/kbn_management_settings_types.mdx
+++ b/api_docs/kbn_management_settings_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-types
title: "@kbn/management-settings-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-types']
---
import kbnManagementSettingsTypesObj from './kbn_management_settings_types.devdocs.json';
diff --git a/api_docs/kbn_management_settings_utilities.mdx b/api_docs/kbn_management_settings_utilities.mdx
index ef42976a98b9c..a3f883ed94495 100644
--- a/api_docs/kbn_management_settings_utilities.mdx
+++ b/api_docs/kbn_management_settings_utilities.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-utilities
title: "@kbn/management-settings-utilities"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-settings-utilities plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-utilities']
---
import kbnManagementSettingsUtilitiesObj from './kbn_management_settings_utilities.devdocs.json';
diff --git a/api_docs/kbn_management_storybook_config.mdx b/api_docs/kbn_management_storybook_config.mdx
index 4e5d02ed8c49a..80303979e793e 100644
--- a/api_docs/kbn_management_storybook_config.mdx
+++ b/api_docs/kbn_management_storybook_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-storybook-config
title: "@kbn/management-storybook-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/management-storybook-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-storybook-config']
---
import kbnManagementStorybookConfigObj from './kbn_management_storybook_config.devdocs.json';
diff --git a/api_docs/kbn_manifest.mdx b/api_docs/kbn_manifest.mdx
index feb66d626ad17..cc46b145585d9 100644
--- a/api_docs/kbn_manifest.mdx
+++ b/api_docs/kbn_manifest.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-manifest
title: "@kbn/manifest"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/manifest plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/manifest']
---
import kbnManifestObj from './kbn_manifest.devdocs.json';
diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx
index ec27d586aabc5..5d102899034f1 100644
--- a/api_docs/kbn_mapbox_gl.mdx
+++ b/api_docs/kbn_mapbox_gl.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl
title: "@kbn/mapbox-gl"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/mapbox-gl plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl']
---
import kbnMapboxGlObj from './kbn_mapbox_gl.devdocs.json';
diff --git a/api_docs/kbn_maps_vector_tile_utils.mdx b/api_docs/kbn_maps_vector_tile_utils.mdx
index 700e6bfedb099..8f31240c28f3c 100644
--- a/api_docs/kbn_maps_vector_tile_utils.mdx
+++ b/api_docs/kbn_maps_vector_tile_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-maps-vector-tile-utils
title: "@kbn/maps-vector-tile-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/maps-vector-tile-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/maps-vector-tile-utils']
---
import kbnMapsVectorTileUtilsObj from './kbn_maps_vector_tile_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx
index 70c8b8f3d2e5a..d1f767281e4a9 100644
--- a/api_docs/kbn_ml_agg_utils.mdx
+++ b/api_docs/kbn_ml_agg_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-agg-utils
title: "@kbn/ml-agg-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-agg-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-agg-utils']
---
import kbnMlAggUtilsObj from './kbn_ml_agg_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_anomaly_utils.mdx b/api_docs/kbn_ml_anomaly_utils.mdx
index c841f8b08c789..a34cac1277726 100644
--- a/api_docs/kbn_ml_anomaly_utils.mdx
+++ b/api_docs/kbn_ml_anomaly_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-anomaly-utils
title: "@kbn/ml-anomaly-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-anomaly-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-anomaly-utils']
---
import kbnMlAnomalyUtilsObj from './kbn_ml_anomaly_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_cancellable_search.mdx b/api_docs/kbn_ml_cancellable_search.mdx
index bf0e76670f3a2..c727a3b21d752 100644
--- a/api_docs/kbn_ml_cancellable_search.mdx
+++ b/api_docs/kbn_ml_cancellable_search.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-cancellable-search
title: "@kbn/ml-cancellable-search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-cancellable-search plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-cancellable-search']
---
import kbnMlCancellableSearchObj from './kbn_ml_cancellable_search.devdocs.json';
diff --git a/api_docs/kbn_ml_category_validator.mdx b/api_docs/kbn_ml_category_validator.mdx
index cd56a757d5d4c..53a8bb9b275ff 100644
--- a/api_docs/kbn_ml_category_validator.mdx
+++ b/api_docs/kbn_ml_category_validator.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-category-validator
title: "@kbn/ml-category-validator"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-category-validator plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-category-validator']
---
import kbnMlCategoryValidatorObj from './kbn_ml_category_validator.devdocs.json';
diff --git a/api_docs/kbn_ml_chi2test.mdx b/api_docs/kbn_ml_chi2test.mdx
index 42a0702ed7590..674ef0dd45ff7 100644
--- a/api_docs/kbn_ml_chi2test.mdx
+++ b/api_docs/kbn_ml_chi2test.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-chi2test
title: "@kbn/ml-chi2test"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-chi2test plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-chi2test']
---
import kbnMlChi2testObj from './kbn_ml_chi2test.devdocs.json';
diff --git a/api_docs/kbn_ml_data_frame_analytics_utils.mdx b/api_docs/kbn_ml_data_frame_analytics_utils.mdx
index b1c57841dbbbd..a4593811d2578 100644
--- a/api_docs/kbn_ml_data_frame_analytics_utils.mdx
+++ b/api_docs/kbn_ml_data_frame_analytics_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-data-frame-analytics-utils
title: "@kbn/ml-data-frame-analytics-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-data-frame-analytics-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-data-frame-analytics-utils']
---
import kbnMlDataFrameAnalyticsUtilsObj from './kbn_ml_data_frame_analytics_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_data_grid.mdx b/api_docs/kbn_ml_data_grid.mdx
index 16568eb341919..082edcd726da5 100644
--- a/api_docs/kbn_ml_data_grid.mdx
+++ b/api_docs/kbn_ml_data_grid.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-data-grid
title: "@kbn/ml-data-grid"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-data-grid plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-data-grid']
---
import kbnMlDataGridObj from './kbn_ml_data_grid.devdocs.json';
diff --git a/api_docs/kbn_ml_date_picker.mdx b/api_docs/kbn_ml_date_picker.mdx
index 7b14337f31e75..2c06b6d16d11f 100644
--- a/api_docs/kbn_ml_date_picker.mdx
+++ b/api_docs/kbn_ml_date_picker.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-date-picker
title: "@kbn/ml-date-picker"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-date-picker plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-date-picker']
---
import kbnMlDatePickerObj from './kbn_ml_date_picker.devdocs.json';
diff --git a/api_docs/kbn_ml_date_utils.mdx b/api_docs/kbn_ml_date_utils.mdx
index 8634170ec87de..7ad62d6781f28 100644
--- a/api_docs/kbn_ml_date_utils.mdx
+++ b/api_docs/kbn_ml_date_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-date-utils
title: "@kbn/ml-date-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-date-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-date-utils']
---
import kbnMlDateUtilsObj from './kbn_ml_date_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_error_utils.mdx b/api_docs/kbn_ml_error_utils.mdx
index ffd72ce2aab3e..5646e8364214a 100644
--- a/api_docs/kbn_ml_error_utils.mdx
+++ b/api_docs/kbn_ml_error_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-error-utils
title: "@kbn/ml-error-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-error-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-error-utils']
---
import kbnMlErrorUtilsObj from './kbn_ml_error_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_field_stats_flyout.mdx b/api_docs/kbn_ml_field_stats_flyout.mdx
index 681e4f82390e2..464bb537016a4 100644
--- a/api_docs/kbn_ml_field_stats_flyout.mdx
+++ b/api_docs/kbn_ml_field_stats_flyout.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-field-stats-flyout
title: "@kbn/ml-field-stats-flyout"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-field-stats-flyout plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-field-stats-flyout']
---
import kbnMlFieldStatsFlyoutObj from './kbn_ml_field_stats_flyout.devdocs.json';
diff --git a/api_docs/kbn_ml_in_memory_table.mdx b/api_docs/kbn_ml_in_memory_table.mdx
index a4e54f4c6c329..3f4071ea9ac0e 100644
--- a/api_docs/kbn_ml_in_memory_table.mdx
+++ b/api_docs/kbn_ml_in_memory_table.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-in-memory-table
title: "@kbn/ml-in-memory-table"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-in-memory-table plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-in-memory-table']
---
import kbnMlInMemoryTableObj from './kbn_ml_in_memory_table.devdocs.json';
diff --git a/api_docs/kbn_ml_is_defined.mdx b/api_docs/kbn_ml_is_defined.mdx
index 8fa0448e1330c..8f134b49723c0 100644
--- a/api_docs/kbn_ml_is_defined.mdx
+++ b/api_docs/kbn_ml_is_defined.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-defined
title: "@kbn/ml-is-defined"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-is-defined plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-defined']
---
import kbnMlIsDefinedObj from './kbn_ml_is_defined.devdocs.json';
diff --git a/api_docs/kbn_ml_is_populated_object.mdx b/api_docs/kbn_ml_is_populated_object.mdx
index c13c05c3d9e76..c8f90b44d6962 100644
--- a/api_docs/kbn_ml_is_populated_object.mdx
+++ b/api_docs/kbn_ml_is_populated_object.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-populated-object
title: "@kbn/ml-is-populated-object"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-is-populated-object plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-populated-object']
---
import kbnMlIsPopulatedObjectObj from './kbn_ml_is_populated_object.devdocs.json';
diff --git a/api_docs/kbn_ml_kibana_theme.mdx b/api_docs/kbn_ml_kibana_theme.mdx
index 041ba5826ad73..0d588060308eb 100644
--- a/api_docs/kbn_ml_kibana_theme.mdx
+++ b/api_docs/kbn_ml_kibana_theme.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-kibana-theme
title: "@kbn/ml-kibana-theme"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-kibana-theme plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-kibana-theme']
---
import kbnMlKibanaThemeObj from './kbn_ml_kibana_theme.devdocs.json';
diff --git a/api_docs/kbn_ml_local_storage.mdx b/api_docs/kbn_ml_local_storage.mdx
index a4c5522599f98..cfed877d5f12f 100644
--- a/api_docs/kbn_ml_local_storage.mdx
+++ b/api_docs/kbn_ml_local_storage.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-local-storage
title: "@kbn/ml-local-storage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-local-storage plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-local-storage']
---
import kbnMlLocalStorageObj from './kbn_ml_local_storage.devdocs.json';
diff --git a/api_docs/kbn_ml_nested_property.mdx b/api_docs/kbn_ml_nested_property.mdx
index a387a63b8085b..898061cfcf982 100644
--- a/api_docs/kbn_ml_nested_property.mdx
+++ b/api_docs/kbn_ml_nested_property.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-nested-property
title: "@kbn/ml-nested-property"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-nested-property plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-nested-property']
---
import kbnMlNestedPropertyObj from './kbn_ml_nested_property.devdocs.json';
diff --git a/api_docs/kbn_ml_number_utils.mdx b/api_docs/kbn_ml_number_utils.mdx
index fab09b1da8db7..5a13b2fc38f74 100644
--- a/api_docs/kbn_ml_number_utils.mdx
+++ b/api_docs/kbn_ml_number_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-number-utils
title: "@kbn/ml-number-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-number-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-number-utils']
---
import kbnMlNumberUtilsObj from './kbn_ml_number_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_parse_interval.mdx b/api_docs/kbn_ml_parse_interval.mdx
index 02b71e413f27d..1ba4c748a5859 100644
--- a/api_docs/kbn_ml_parse_interval.mdx
+++ b/api_docs/kbn_ml_parse_interval.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-parse-interval
title: "@kbn/ml-parse-interval"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-parse-interval plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-parse-interval']
---
import kbnMlParseIntervalObj from './kbn_ml_parse_interval.devdocs.json';
diff --git a/api_docs/kbn_ml_query_utils.mdx b/api_docs/kbn_ml_query_utils.mdx
index 88f2b26706a03..d41088d23d8e9 100644
--- a/api_docs/kbn_ml_query_utils.mdx
+++ b/api_docs/kbn_ml_query_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-query-utils
title: "@kbn/ml-query-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-query-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-query-utils']
---
import kbnMlQueryUtilsObj from './kbn_ml_query_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_random_sampler_utils.mdx b/api_docs/kbn_ml_random_sampler_utils.mdx
index db8c122bd2aa8..3275a7f1d678d 100644
--- a/api_docs/kbn_ml_random_sampler_utils.mdx
+++ b/api_docs/kbn_ml_random_sampler_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-random-sampler-utils
title: "@kbn/ml-random-sampler-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-random-sampler-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-random-sampler-utils']
---
import kbnMlRandomSamplerUtilsObj from './kbn_ml_random_sampler_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_route_utils.mdx b/api_docs/kbn_ml_route_utils.mdx
index 5a299b3f6d515..8c18827d654bd 100644
--- a/api_docs/kbn_ml_route_utils.mdx
+++ b/api_docs/kbn_ml_route_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-route-utils
title: "@kbn/ml-route-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-route-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-route-utils']
---
import kbnMlRouteUtilsObj from './kbn_ml_route_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_runtime_field_utils.mdx b/api_docs/kbn_ml_runtime_field_utils.mdx
index 981cd6397274f..a3f08fba7f8b4 100644
--- a/api_docs/kbn_ml_runtime_field_utils.mdx
+++ b/api_docs/kbn_ml_runtime_field_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-runtime-field-utils
title: "@kbn/ml-runtime-field-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-runtime-field-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-runtime-field-utils']
---
import kbnMlRuntimeFieldUtilsObj from './kbn_ml_runtime_field_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx
index 1845afe27503f..bd04380328e90 100644
--- a/api_docs/kbn_ml_string_hash.mdx
+++ b/api_docs/kbn_ml_string_hash.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-string-hash
title: "@kbn/ml-string-hash"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-string-hash plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-string-hash']
---
import kbnMlStringHashObj from './kbn_ml_string_hash.devdocs.json';
diff --git a/api_docs/kbn_ml_time_buckets.mdx b/api_docs/kbn_ml_time_buckets.mdx
index e2231a9a3b732..a15fb9f3e8829 100644
--- a/api_docs/kbn_ml_time_buckets.mdx
+++ b/api_docs/kbn_ml_time_buckets.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-time-buckets
title: "@kbn/ml-time-buckets"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-time-buckets plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-time-buckets']
---
import kbnMlTimeBucketsObj from './kbn_ml_time_buckets.devdocs.json';
diff --git a/api_docs/kbn_ml_trained_models_utils.mdx b/api_docs/kbn_ml_trained_models_utils.mdx
index 2758b10ae72ee..37a0635121546 100644
--- a/api_docs/kbn_ml_trained_models_utils.mdx
+++ b/api_docs/kbn_ml_trained_models_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-trained-models-utils
title: "@kbn/ml-trained-models-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-trained-models-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-trained-models-utils']
---
import kbnMlTrainedModelsUtilsObj from './kbn_ml_trained_models_utils.devdocs.json';
diff --git a/api_docs/kbn_ml_ui_actions.mdx b/api_docs/kbn_ml_ui_actions.mdx
index 3984e1a91eedb..62519710c59f7 100644
--- a/api_docs/kbn_ml_ui_actions.mdx
+++ b/api_docs/kbn_ml_ui_actions.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-ui-actions
title: "@kbn/ml-ui-actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-ui-actions plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-ui-actions']
---
import kbnMlUiActionsObj from './kbn_ml_ui_actions.devdocs.json';
diff --git a/api_docs/kbn_ml_url_state.mdx b/api_docs/kbn_ml_url_state.mdx
index be7817da52332..4ed5e4a5f97ae 100644
--- a/api_docs/kbn_ml_url_state.mdx
+++ b/api_docs/kbn_ml_url_state.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-url-state
title: "@kbn/ml-url-state"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-url-state plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-url-state']
---
import kbnMlUrlStateObj from './kbn_ml_url_state.devdocs.json';
diff --git a/api_docs/kbn_ml_validators.mdx b/api_docs/kbn_ml_validators.mdx
index 3376edb1b7414..ae66a145c9406 100644
--- a/api_docs/kbn_ml_validators.mdx
+++ b/api_docs/kbn_ml_validators.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-validators
title: "@kbn/ml-validators"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ml-validators plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-validators']
---
import kbnMlValidatorsObj from './kbn_ml_validators.devdocs.json';
diff --git a/api_docs/kbn_mock_idp_utils.mdx b/api_docs/kbn_mock_idp_utils.mdx
index 1a8f7b21d1a4b..f22302915d2e7 100644
--- a/api_docs/kbn_mock_idp_utils.mdx
+++ b/api_docs/kbn_mock_idp_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-mock-idp-utils
title: "@kbn/mock-idp-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/mock-idp-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mock-idp-utils']
---
import kbnMockIdpUtilsObj from './kbn_mock_idp_utils.devdocs.json';
diff --git a/api_docs/kbn_monaco.devdocs.json b/api_docs/kbn_monaco.devdocs.json
index fcb876065c8a2..14dd9560fc8b7 100644
--- a/api_docs/kbn_monaco.devdocs.json
+++ b/api_docs/kbn_monaco.devdocs.json
@@ -1385,6 +1385,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
+ {
+ "parentPluginId": "@kbn/monaco",
+ "id": "def-common.ESQL_DARK_THEME_ID",
+ "type": "string",
+ "tags": [],
+ "label": "ESQL_DARK_THEME_ID",
+ "description": [],
+ "signature": [
+ "\"esqlThemeDark\""
+ ],
+ "path": "packages/kbn-monaco/src/esql/lib/constants.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
{
"parentPluginId": "@kbn/monaco",
"id": "def-common.ESQL_LANG_ID",
@@ -1402,13 +1417,13 @@
},
{
"parentPluginId": "@kbn/monaco",
- "id": "def-common.ESQL_THEME_ID",
+ "id": "def-common.ESQL_LIGHT_THEME_ID",
"type": "string",
"tags": [],
- "label": "ESQL_THEME_ID",
+ "label": "ESQL_LIGHT_THEME_ID",
"description": [],
"signature": [
- "\"esqlTheme\""
+ "\"esqlThemeLight\""
],
"path": "packages/kbn-monaco/src/esql/lib/constants.ts",
"deprecated": false,
diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx
index 5ee10830ae798..810fb76125954 100644
--- a/api_docs/kbn_monaco.mdx
+++ b/api_docs/kbn_monaco.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-monaco
title: "@kbn/monaco"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/monaco plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco']
---
import kbnMonacoObj from './kbn_monaco.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 123 | 0 | 123 | 3 |
+| 124 | 0 | 124 | 3 |
## Common
diff --git a/api_docs/kbn_object_versioning.mdx b/api_docs/kbn_object_versioning.mdx
index 7f9acde039451..18bff52795b65 100644
--- a/api_docs/kbn_object_versioning.mdx
+++ b/api_docs/kbn_object_versioning.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-object-versioning
title: "@kbn/object-versioning"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/object-versioning plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/object-versioning']
---
import kbnObjectVersioningObj from './kbn_object_versioning.devdocs.json';
diff --git a/api_docs/kbn_object_versioning_utils.mdx b/api_docs/kbn_object_versioning_utils.mdx
index 1b36a19c33c19..cda8d84e8e4db 100644
--- a/api_docs/kbn_object_versioning_utils.mdx
+++ b/api_docs/kbn_object_versioning_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-object-versioning-utils
title: "@kbn/object-versioning-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/object-versioning-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/object-versioning-utils']
---
import kbnObjectVersioningUtilsObj from './kbn_object_versioning_utils.devdocs.json';
diff --git a/api_docs/kbn_observability_alert_details.mdx b/api_docs/kbn_observability_alert_details.mdx
index 55177dfde21d8..f8c2cc2edb1f6 100644
--- a/api_docs/kbn_observability_alert_details.mdx
+++ b/api_docs/kbn_observability_alert_details.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-alert-details
title: "@kbn/observability-alert-details"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/observability-alert-details plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alert-details']
---
import kbnObservabilityAlertDetailsObj from './kbn_observability_alert_details.devdocs.json';
diff --git a/api_docs/kbn_observability_alerting_rule_utils.mdx b/api_docs/kbn_observability_alerting_rule_utils.mdx
index c0854bdcac2f4..57bfe752ba66b 100644
--- a/api_docs/kbn_observability_alerting_rule_utils.mdx
+++ b/api_docs/kbn_observability_alerting_rule_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-alerting-rule-utils
title: "@kbn/observability-alerting-rule-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/observability-alerting-rule-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alerting-rule-utils']
---
import kbnObservabilityAlertingRuleUtilsObj from './kbn_observability_alerting_rule_utils.devdocs.json';
diff --git a/api_docs/kbn_observability_alerting_test_data.mdx b/api_docs/kbn_observability_alerting_test_data.mdx
index ae08a153ff4e9..fdb897dbf3ca0 100644
--- a/api_docs/kbn_observability_alerting_test_data.mdx
+++ b/api_docs/kbn_observability_alerting_test_data.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-alerting-test-data
title: "@kbn/observability-alerting-test-data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/observability-alerting-test-data plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alerting-test-data']
---
import kbnObservabilityAlertingTestDataObj from './kbn_observability_alerting_test_data.devdocs.json';
diff --git a/api_docs/kbn_observability_get_padded_alert_time_range_util.mdx b/api_docs/kbn_observability_get_padded_alert_time_range_util.mdx
index 4d46d5ec4c176..79594ec6a7ae2 100644
--- a/api_docs/kbn_observability_get_padded_alert_time_range_util.mdx
+++ b/api_docs/kbn_observability_get_padded_alert_time_range_util.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-get-padded-alert-time-range-util
title: "@kbn/observability-get-padded-alert-time-range-util"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/observability-get-padded-alert-time-range-util plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-get-padded-alert-time-range-util']
---
import kbnObservabilityGetPaddedAlertTimeRangeUtilObj from './kbn_observability_get_padded_alert_time_range_util.devdocs.json';
diff --git a/api_docs/kbn_observability_logs_overview.mdx b/api_docs/kbn_observability_logs_overview.mdx
index d2f6b5d6b553c..4bd374f8e8b43 100644
--- a/api_docs/kbn_observability_logs_overview.mdx
+++ b/api_docs/kbn_observability_logs_overview.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-logs-overview
title: "@kbn/observability-logs-overview"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/observability-logs-overview plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-logs-overview']
---
import kbnObservabilityLogsOverviewObj from './kbn_observability_logs_overview.devdocs.json';
diff --git a/api_docs/kbn_observability_synthetics_test_data.mdx b/api_docs/kbn_observability_synthetics_test_data.mdx
index d5e4236e7ea30..4ce275c081397 100644
--- a/api_docs/kbn_observability_synthetics_test_data.mdx
+++ b/api_docs/kbn_observability_synthetics_test_data.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-synthetics-test-data
title: "@kbn/observability-synthetics-test-data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/observability-synthetics-test-data plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-synthetics-test-data']
---
import kbnObservabilitySyntheticsTestDataObj from './kbn_observability_synthetics_test_data.devdocs.json';
diff --git a/api_docs/kbn_openapi_bundler.mdx b/api_docs/kbn_openapi_bundler.mdx
index 4d1db95ebb3fc..c128992462fce 100644
--- a/api_docs/kbn_openapi_bundler.mdx
+++ b/api_docs/kbn_openapi_bundler.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-openapi-bundler
title: "@kbn/openapi-bundler"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/openapi-bundler plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/openapi-bundler']
---
import kbnOpenapiBundlerObj from './kbn_openapi_bundler.devdocs.json';
diff --git a/api_docs/kbn_openapi_generator.mdx b/api_docs/kbn_openapi_generator.mdx
index 106bc2e10d351..e9cfda360f57f 100644
--- a/api_docs/kbn_openapi_generator.mdx
+++ b/api_docs/kbn_openapi_generator.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-openapi-generator
title: "@kbn/openapi-generator"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/openapi-generator plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/openapi-generator']
---
import kbnOpenapiGeneratorObj from './kbn_openapi_generator.devdocs.json';
diff --git a/api_docs/kbn_optimizer.devdocs.json b/api_docs/kbn_optimizer.devdocs.json
index 82de9992c06d6..c660b7a84ef44 100644
--- a/api_docs/kbn_optimizer.devdocs.json
+++ b/api_docs/kbn_optimizer.devdocs.json
@@ -268,7 +268,13 @@
"label": "themeTags",
"description": [],
"signature": [
- "ThemeTags"
+ {
+ "pluginId": "@kbn/core-ui-settings-common",
+ "scope": "common",
+ "docId": "kibKbnCoreUiSettingsCommonPluginApi",
+ "section": "def-common.ThemeTags",
+ "text": "ThemeTags"
+ }
],
"path": "packages/kbn-optimizer/src/optimizer/optimizer_config.ts",
"deprecated": false,
diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx
index 7a0ae6a479348..4392fa5df183b 100644
--- a/api_docs/kbn_optimizer.mdx
+++ b/api_docs/kbn_optimizer.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer
title: "@kbn/optimizer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/optimizer plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer']
---
import kbnOptimizerObj from './kbn_optimizer.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kiban
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 45 | 0 | 45 | 10 |
+| 45 | 0 | 45 | 9 |
## Server
diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx
index dd2f68b6552b8..67edcf7c8d849 100644
--- a/api_docs/kbn_optimizer_webpack_helpers.mdx
+++ b/api_docs/kbn_optimizer_webpack_helpers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers
title: "@kbn/optimizer-webpack-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/optimizer-webpack-helpers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers']
---
import kbnOptimizerWebpackHelpersObj from './kbn_optimizer_webpack_helpers.devdocs.json';
diff --git a/api_docs/kbn_osquery_io_ts_types.mdx b/api_docs/kbn_osquery_io_ts_types.mdx
index 1f30574d63c1a..398d5a27ecf33 100644
--- a/api_docs/kbn_osquery_io_ts_types.mdx
+++ b/api_docs/kbn_osquery_io_ts_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-osquery-io-ts-types
title: "@kbn/osquery-io-ts-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/osquery-io-ts-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/osquery-io-ts-types']
---
import kbnOsqueryIoTsTypesObj from './kbn_osquery_io_ts_types.devdocs.json';
diff --git a/api_docs/kbn_panel_loader.mdx b/api_docs/kbn_panel_loader.mdx
index 0af12880143cd..0be4bc90cf332 100644
--- a/api_docs/kbn_panel_loader.mdx
+++ b/api_docs/kbn_panel_loader.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-panel-loader
title: "@kbn/panel-loader"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/panel-loader plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/panel-loader']
---
import kbnPanelLoaderObj from './kbn_panel_loader.devdocs.json';
diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx
index c146f4d3a4ffa..a98583e453757 100644
--- a/api_docs/kbn_performance_testing_dataset_extractor.mdx
+++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor
title: "@kbn/performance-testing-dataset-extractor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/performance-testing-dataset-extractor plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor']
---
import kbnPerformanceTestingDatasetExtractorObj from './kbn_performance_testing_dataset_extractor.devdocs.json';
diff --git a/api_docs/kbn_plugin_check.mdx b/api_docs/kbn_plugin_check.mdx
index afa4fc281e898..cbca4fb99b6b3 100644
--- a/api_docs/kbn_plugin_check.mdx
+++ b/api_docs/kbn_plugin_check.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-check
title: "@kbn/plugin-check"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/plugin-check plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-check']
---
import kbnPluginCheckObj from './kbn_plugin_check.devdocs.json';
diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx
index a7fbfed669423..04778804a1e57 100644
--- a/api_docs/kbn_plugin_generator.mdx
+++ b/api_docs/kbn_plugin_generator.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator
title: "@kbn/plugin-generator"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/plugin-generator plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator']
---
import kbnPluginGeneratorObj from './kbn_plugin_generator.devdocs.json';
diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx
index 0e4888b72f3a7..1dd03c0bc9571 100644
--- a/api_docs/kbn_plugin_helpers.mdx
+++ b/api_docs/kbn_plugin_helpers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers
title: "@kbn/plugin-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/plugin-helpers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers']
---
import kbnPluginHelpersObj from './kbn_plugin_helpers.devdocs.json';
diff --git a/api_docs/kbn_presentation_containers.mdx b/api_docs/kbn_presentation_containers.mdx
index 8d7dce5c26b90..fa135c5056fce 100644
--- a/api_docs/kbn_presentation_containers.mdx
+++ b/api_docs/kbn_presentation_containers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-presentation-containers
title: "@kbn/presentation-containers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/presentation-containers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/presentation-containers']
---
import kbnPresentationContainersObj from './kbn_presentation_containers.devdocs.json';
diff --git a/api_docs/kbn_presentation_publishing.mdx b/api_docs/kbn_presentation_publishing.mdx
index d9db8eee61acc..922a1caac7dd1 100644
--- a/api_docs/kbn_presentation_publishing.mdx
+++ b/api_docs/kbn_presentation_publishing.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-presentation-publishing
title: "@kbn/presentation-publishing"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/presentation-publishing plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/presentation-publishing']
---
import kbnPresentationPublishingObj from './kbn_presentation_publishing.devdocs.json';
diff --git a/api_docs/kbn_product_doc_artifact_builder.mdx b/api_docs/kbn_product_doc_artifact_builder.mdx
index faa3c1f8a35df..7b285887ef184 100644
--- a/api_docs/kbn_product_doc_artifact_builder.mdx
+++ b/api_docs/kbn_product_doc_artifact_builder.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-product-doc-artifact-builder
title: "@kbn/product-doc-artifact-builder"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/product-doc-artifact-builder plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/product-doc-artifact-builder']
---
import kbnProductDocArtifactBuilderObj from './kbn_product_doc_artifact_builder.devdocs.json';
diff --git a/api_docs/kbn_profiling_utils.mdx b/api_docs/kbn_profiling_utils.mdx
index ff791ad662e9f..96ebcb96dcbda 100644
--- a/api_docs/kbn_profiling_utils.mdx
+++ b/api_docs/kbn_profiling_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-profiling-utils
title: "@kbn/profiling-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/profiling-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/profiling-utils']
---
import kbnProfilingUtilsObj from './kbn_profiling_utils.devdocs.json';
diff --git a/api_docs/kbn_random_sampling.mdx b/api_docs/kbn_random_sampling.mdx
index 168d82eb86b0c..8c52041cc08ca 100644
--- a/api_docs/kbn_random_sampling.mdx
+++ b/api_docs/kbn_random_sampling.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-random-sampling
title: "@kbn/random-sampling"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/random-sampling plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/random-sampling']
---
import kbnRandomSamplingObj from './kbn_random_sampling.devdocs.json';
diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx
index 9ee31379063aa..6e68801f861d1 100644
--- a/api_docs/kbn_react_field.mdx
+++ b/api_docs/kbn_react_field.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-field
title: "@kbn/react-field"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/react-field plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field']
---
import kbnReactFieldObj from './kbn_react_field.devdocs.json';
diff --git a/api_docs/kbn_react_hooks.devdocs.json b/api_docs/kbn_react_hooks.devdocs.json
index fbe31cf8a7b8c..5482346499d30 100644
--- a/api_docs/kbn_react_hooks.devdocs.json
+++ b/api_docs/kbn_react_hooks.devdocs.json
@@ -58,6 +58,24 @@
],
"returnComment": [],
"initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/react-hooks",
+ "id": "def-common.useErrorTextStyle",
+ "type": "Function",
+ "tags": [],
+ "label": "useErrorTextStyle",
+ "description": [],
+ "signature": [
+ "() => ",
+ "SerializedStyles"
+ ],
+ "path": "packages/kbn-react-hooks/src/use_error_text_style/use_error_text_style.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [],
+ "returnComment": [],
+ "initialIsOpen": false
}
],
"interfaces": [
diff --git a/api_docs/kbn_react_hooks.mdx b/api_docs/kbn_react_hooks.mdx
index c5561ce52cc48..ad1a232f33f50 100644
--- a/api_docs/kbn_react_hooks.mdx
+++ b/api_docs/kbn_react_hooks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-hooks
title: "@kbn/react-hooks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/react-hooks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-hooks']
---
import kbnReactHooksObj from './kbn_react_hooks.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 8 | 0 | 7 | 0 |
+| 9 | 0 | 8 | 0 |
## Common
diff --git a/api_docs/kbn_react_kibana_context_common.devdocs.json b/api_docs/kbn_react_kibana_context_common.devdocs.json
index d3b60e47425cb..0f29deb8b761e 100644
--- a/api_docs/kbn_react_kibana_context_common.devdocs.json
+++ b/api_docs/kbn_react_kibana_context_common.devdocs.json
@@ -1,11 +1,27 @@
{
"id": "@kbn/react-kibana-context-common",
"client": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "server": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/react-kibana-context-common",
- "id": "def-public.getColorMode",
+ "id": "def-common.getColorMode",
"type": "Function",
"tags": [],
"label": "getColorMode",
@@ -16,9 +32,9 @@
"(theme: ",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.KibanaTheme",
+ "section": "def-common.KibanaTheme",
"text": "KibanaTheme"
},
") => ",
@@ -30,7 +46,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-common",
- "id": "def-public.getColorMode.$1",
+ "id": "def-common.getColorMode.$1",
"type": "Object",
"tags": [],
"label": "theme",
@@ -40,9 +56,9 @@
"signature": [
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.KibanaTheme",
+ "section": "def-common.KibanaTheme",
"text": "KibanaTheme"
}
],
@@ -56,12 +72,53 @@
"EuiThemeColorModeStandard"
],
"initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/react-kibana-context-common",
+ "id": "def-common.getThemeConfigByName",
+ "type": "Function",
+ "tags": [],
+ "label": "getThemeConfigByName",
+ "description": [],
+ "signature": [
+ "(name: string) => ",
+ {
+ "pluginId": "@kbn/react-kibana-context-common",
+ "scope": "common",
+ "docId": "kibKbnReactKibanaContextCommonPluginApi",
+ "section": "def-common.ThemeConfig",
+ "text": "ThemeConfig"
+ },
+ " | null"
+ ],
+ "path": "packages/react/kibana_context/common/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/react-kibana-context-common",
+ "id": "def-common.getThemeConfigByName.$1",
+ "type": "string",
+ "tags": [],
+ "label": "name",
+ "description": [],
+ "signature": [
+ "string"
+ ],
+ "path": "packages/react/kibana_context/common/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/react-kibana-context-common",
- "id": "def-public.KibanaTheme",
+ "id": "def-common.KibanaTheme",
"type": "Interface",
"tags": [],
"label": "KibanaTheme",
@@ -74,7 +131,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-common",
- "id": "def-public.KibanaTheme.darkMode",
+ "id": "def-common.KibanaTheme.darkMode",
"type": "boolean",
"tags": [],
"label": "darkMode",
@@ -84,13 +141,58 @@
"path": "packages/react/kibana_context/common/types.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/react-kibana-context-common",
+ "id": "def-common.KibanaTheme.name",
+ "type": "string",
+ "tags": [],
+ "label": "name",
+ "description": [
+ "\nName of the active theme"
+ ],
+ "path": "packages/react/kibana_context/common/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/react-kibana-context-common",
- "id": "def-public.ThemeServiceStart",
+ "id": "def-common.ThemeConfig",
+ "type": "Interface",
+ "tags": [],
+ "label": "ThemeConfig",
+ "description": [],
+ "path": "packages/react/kibana_context/common/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/react-kibana-context-common",
+ "id": "def-common.ThemeConfig.euiTheme",
+ "type": "Object",
+ "tags": [],
+ "label": "euiTheme",
+ "description": [],
+ "signature": [
+ "{ root: ",
+ "EuiThemeShape",
+ "; model: ",
+ "EuiThemeShape",
+ "; key: string; }"
+ ],
+ "path": "packages/react/kibana_context/common/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/react-kibana-context-common",
+ "id": "def-common.ThemeServiceStart",
"type": "Interface",
"tags": [],
"label": "ThemeServiceStart",
@@ -103,7 +205,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-common",
- "id": "def-public.ThemeServiceStart.theme$",
+ "id": "def-common.ThemeServiceStart.theme$",
"type": "Object",
"tags": [],
"label": "theme$",
@@ -113,9 +215,9 @@
"<",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.KibanaTheme",
+ "section": "def-common.KibanaTheme",
"text": "KibanaTheme"
},
">"
@@ -133,7 +235,28 @@
"objects": [
{
"parentPluginId": "@kbn/react-kibana-context-common",
- "id": "def-public.defaultTheme",
+ "id": "def-common.DEFAULT_THEME_CONFIG",
+ "type": "Object",
+ "tags": [],
+ "label": "DEFAULT_THEME_CONFIG",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "@kbn/react-kibana-context-common",
+ "scope": "common",
+ "docId": "kibKbnReactKibanaContextCommonPluginApi",
+ "section": "def-common.ThemeConfig",
+ "text": "ThemeConfig"
+ }
+ ],
+ "path": "packages/react/kibana_context/common/theme.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/react-kibana-context-common",
+ "id": "def-common.defaultTheme",
"type": "Object",
"tags": [],
"label": "defaultTheme",
@@ -146,7 +269,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-common",
- "id": "def-public.defaultTheme.darkMode",
+ "id": "def-common.defaultTheme.darkMode",
"type": "boolean",
"tags": [],
"label": "darkMode",
@@ -157,26 +280,21 @@
"path": "packages/react/kibana_context/common/index.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/react-kibana-context-common",
+ "id": "def-common.defaultTheme.name",
+ "type": "string",
+ "tags": [],
+ "label": "name",
+ "description": [],
+ "path": "packages/react/kibana_context/common/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
}
]
- },
- "server": {
- "classes": [],
- "functions": [],
- "interfaces": [],
- "enums": [],
- "misc": [],
- "objects": []
- },
- "common": {
- "classes": [],
- "functions": [],
- "interfaces": [],
- "enums": [],
- "misc": [],
- "objects": []
}
}
\ No newline at end of file
diff --git a/api_docs/kbn_react_kibana_context_common.mdx b/api_docs/kbn_react_kibana_context_common.mdx
index 269465f50360f..16f2e3a10ec0d 100644
--- a/api_docs/kbn_react_kibana_context_common.mdx
+++ b/api_docs/kbn_react_kibana_context_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-common
title: "@kbn/react-kibana-context-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/react-kibana-context-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-common']
---
import kbnReactKibanaContextCommonObj from './kbn_react_kibana_context_common.devdocs.json';
@@ -21,16 +21,16 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 8 | 0 | 2 | 0 |
+| 15 | 0 | 8 | 0 |
-## Client
+## Common
### Objects
-
+
### Functions
-
+
### Interfaces
-
+
diff --git a/api_docs/kbn_react_kibana_context_render.devdocs.json b/api_docs/kbn_react_kibana_context_render.devdocs.json
index e8d53123a8180..ff9487eef622e 100644
--- a/api_docs/kbn_react_kibana_context_render.devdocs.json
+++ b/api_docs/kbn_react_kibana_context_render.devdocs.json
@@ -103,9 +103,9 @@
", \"reportEvent\"> | undefined; theme: ",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
},
"; modify?: ",
diff --git a/api_docs/kbn_react_kibana_context_render.mdx b/api_docs/kbn_react_kibana_context_render.mdx
index cb5b0e3951ec8..fbb48d167900b 100644
--- a/api_docs/kbn_react_kibana_context_render.mdx
+++ b/api_docs/kbn_react_kibana_context_render.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-render
title: "@kbn/react-kibana-context-render"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/react-kibana-context-render plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-render']
---
import kbnReactKibanaContextRenderObj from './kbn_react_kibana_context_render.devdocs.json';
diff --git a/api_docs/kbn_react_kibana_context_root.devdocs.json b/api_docs/kbn_react_kibana_context_root.devdocs.json
index f0bce73d3d1e4..cd903cc6ea8e9 100644
--- a/api_docs/kbn_react_kibana_context_root.devdocs.json
+++ b/api_docs/kbn_react_kibana_context_root.devdocs.json
@@ -1,11 +1,27 @@
{
"id": "@kbn/react-kibana-context-root",
"client": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "server": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaEuiProvider",
+ "id": "def-common.KibanaEuiProvider",
"type": "Function",
"tags": [],
"label": "KibanaEuiProvider",
@@ -16,9 +32,9 @@
"({ theme: { theme$ }, globalStyles: globalStylesProp, colorMode: colorModeProp, modify, children, }: React.PropsWithChildren<",
{
"pluginId": "@kbn/react-kibana-context-root",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextRootPluginApi",
- "section": "def-public.KibanaEuiProviderProps",
+ "section": "def-common.KibanaEuiProviderProps",
"text": "KibanaEuiProviderProps"
},
">) => React.JSX.Element"
@@ -29,7 +45,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaEuiProvider.$1",
+ "id": "def-common.KibanaEuiProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n theme: { theme$ },\n globalStyles: globalStylesProp,\n colorMode: colorModeProp,\n modify,\n children,\n}",
@@ -38,9 +54,9 @@
"React.PropsWithChildren<",
{
"pluginId": "@kbn/react-kibana-context-root",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextRootPluginApi",
- "section": "def-public.KibanaEuiProviderProps",
+ "section": "def-common.KibanaEuiProviderProps",
"text": "KibanaEuiProviderProps"
},
">"
@@ -56,7 +72,7 @@
},
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaRootContextProvider",
+ "id": "def-common.KibanaRootContextProvider",
"type": "Function",
"tags": [],
"label": "KibanaRootContextProvider",
@@ -67,9 +83,9 @@
"({ children, i18n, ...props }: React.PropsWithChildren<",
{
"pluginId": "@kbn/react-kibana-context-root",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextRootPluginApi",
- "section": "def-public.KibanaRootContextProviderProps",
+ "section": "def-common.KibanaRootContextProviderProps",
"text": "KibanaRootContextProviderProps"
},
">) => React.JSX.Element"
@@ -80,7 +96,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaRootContextProvider.$1",
+ "id": "def-common.KibanaRootContextProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n i18n,\n ...props\n}",
@@ -89,9 +105,9 @@
"React.PropsWithChildren<",
{
"pluginId": "@kbn/react-kibana-context-root",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextRootPluginApi",
- "section": "def-public.KibanaRootContextProviderProps",
+ "section": "def-common.KibanaRootContextProviderProps",
"text": "KibanaRootContextProviderProps"
},
">"
@@ -109,7 +125,7 @@
"interfaces": [
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaEuiProviderProps",
+ "id": "def-common.KibanaEuiProviderProps",
"type": "Interface",
"tags": [],
"label": "KibanaEuiProviderProps",
@@ -119,9 +135,9 @@
"signature": [
{
"pluginId": "@kbn/react-kibana-context-root",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextRootPluginApi",
- "section": "def-public.KibanaEuiProviderProps",
+ "section": "def-common.KibanaEuiProviderProps",
"text": "KibanaEuiProviderProps"
},
" extends Pick<",
@@ -134,7 +150,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaEuiProviderProps.theme",
+ "id": "def-common.KibanaEuiProviderProps.theme",
"type": "Object",
"tags": [],
"label": "theme",
@@ -142,9 +158,9 @@
"signature": [
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
}
],
@@ -154,7 +170,7 @@
},
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaEuiProviderProps.globalStyles",
+ "id": "def-common.KibanaEuiProviderProps.globalStyles",
"type": "CompoundType",
"tags": [],
"label": "globalStyles",
@@ -171,7 +187,7 @@
},
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaRootContextProviderProps",
+ "id": "def-common.KibanaRootContextProviderProps",
"type": "Interface",
"tags": [],
"label": "KibanaRootContextProviderProps",
@@ -181,17 +197,17 @@
"signature": [
{
"pluginId": "@kbn/react-kibana-context-root",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextRootPluginApi",
- "section": "def-public.KibanaRootContextProviderProps",
+ "section": "def-common.KibanaRootContextProviderProps",
"text": "KibanaRootContextProviderProps"
},
" extends ",
{
"pluginId": "@kbn/react-kibana-context-root",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextRootPluginApi",
- "section": "def-public.KibanaEuiProviderProps",
+ "section": "def-common.KibanaEuiProviderProps",
"text": "KibanaEuiProviderProps"
}
],
@@ -201,7 +217,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaRootContextProviderProps.i18n",
+ "id": "def-common.KibanaRootContextProviderProps.i18n",
"type": "Object",
"tags": [],
"label": "i18n",
@@ -223,7 +239,7 @@
},
{
"parentPluginId": "@kbn/react-kibana-context-root",
- "id": "def-public.KibanaRootContextProviderProps.analytics",
+ "id": "def-common.KibanaRootContextProviderProps.analytics",
"type": "Object",
"tags": [],
"label": "analytics",
@@ -252,21 +268,5 @@
"enums": [],
"misc": [],
"objects": []
- },
- "server": {
- "classes": [],
- "functions": [],
- "interfaces": [],
- "enums": [],
- "misc": [],
- "objects": []
- },
- "common": {
- "classes": [],
- "functions": [],
- "interfaces": [],
- "enums": [],
- "misc": [],
- "objects": []
}
}
\ No newline at end of file
diff --git a/api_docs/kbn_react_kibana_context_root.mdx b/api_docs/kbn_react_kibana_context_root.mdx
index 79d8976166371..0d9b39a6cf83b 100644
--- a/api_docs/kbn_react_kibana_context_root.mdx
+++ b/api_docs/kbn_react_kibana_context_root.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-root
title: "@kbn/react-kibana-context-root"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/react-kibana-context-root plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-root']
---
import kbnReactKibanaContextRootObj from './kbn_react_kibana_context_root.devdocs.json';
@@ -23,11 +23,11 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
|-------------------|-----------|------------------------|-----------------|
| 10 | 0 | 4 | 0 |
-## Client
+## Common
### Functions
-
+
### Interfaces
-
+
diff --git a/api_docs/kbn_react_kibana_context_styled.mdx b/api_docs/kbn_react_kibana_context_styled.mdx
index e5f6676bb311c..93d2d0bb55520 100644
--- a/api_docs/kbn_react_kibana_context_styled.mdx
+++ b/api_docs/kbn_react_kibana_context_styled.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-styled
title: "@kbn/react-kibana-context-styled"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/react-kibana-context-styled plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-styled']
---
import kbnReactKibanaContextStyledObj from './kbn_react_kibana_context_styled.devdocs.json';
diff --git a/api_docs/kbn_react_kibana_context_theme.devdocs.json b/api_docs/kbn_react_kibana_context_theme.devdocs.json
index 5e0547a0326b2..7a9c3c53f6066 100644
--- a/api_docs/kbn_react_kibana_context_theme.devdocs.json
+++ b/api_docs/kbn_react_kibana_context_theme.devdocs.json
@@ -1,11 +1,27 @@
{
"id": "@kbn/react-kibana-context-theme",
"client": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "server": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.KibanaThemeProvider",
+ "id": "def-common.KibanaThemeProvider",
"type": "Function",
"tags": [],
"label": "KibanaThemeProvider",
@@ -16,9 +32,9 @@
"({ theme, children, ...props }: ",
{
"pluginId": "@kbn/react-kibana-context-theme",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextThemePluginApi",
- "section": "def-public.KibanaThemeProviderProps",
+ "section": "def-common.KibanaThemeProviderProps",
"text": "KibanaThemeProviderProps"
},
") => React.JSX.Element"
@@ -30,7 +46,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.KibanaThemeProvider.$1",
+ "id": "def-common.KibanaThemeProvider.$1",
"type": "Object",
"tags": [],
"label": "__0",
@@ -38,9 +54,9 @@
"signature": [
{
"pluginId": "@kbn/react-kibana-context-theme",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextThemePluginApi",
- "section": "def-public.KibanaThemeProviderProps",
+ "section": "def-common.KibanaThemeProviderProps",
"text": "KibanaThemeProviderProps"
}
],
@@ -53,7 +69,7 @@
},
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.wrapWithTheme",
+ "id": "def-common.wrapWithTheme",
"type": "Function",
"tags": [],
"label": "wrapWithTheme",
@@ -64,9 +80,9 @@
"(node: React.ReactNode, theme: ",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
},
") => React.JSX.Element"
@@ -77,7 +93,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.wrapWithTheme.$1",
+ "id": "def-common.wrapWithTheme.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
@@ -94,7 +110,7 @@
},
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.wrapWithTheme.$2",
+ "id": "def-common.wrapWithTheme.$2",
"type": "Object",
"tags": [],
"label": "theme",
@@ -104,9 +120,9 @@
"signature": [
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
}
],
@@ -123,7 +139,7 @@
"interfaces": [
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.KibanaTheme",
+ "id": "def-common.KibanaTheme",
"type": "Interface",
"tags": [],
"label": "KibanaTheme",
@@ -136,7 +152,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.KibanaTheme.darkMode",
+ "id": "def-common.KibanaTheme.darkMode",
"type": "boolean",
"tags": [],
"label": "darkMode",
@@ -146,13 +162,26 @@
"path": "packages/react/kibana_context/common/types.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/react-kibana-context-theme",
+ "id": "def-common.KibanaTheme.name",
+ "type": "string",
+ "tags": [],
+ "label": "name",
+ "description": [
+ "\nName of the active theme"
+ ],
+ "path": "packages/react/kibana_context/common/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.KibanaThemeProviderProps",
+ "id": "def-common.KibanaThemeProviderProps",
"type": "Interface",
"tags": [],
"label": "KibanaThemeProviderProps",
@@ -162,9 +191,9 @@
"signature": [
{
"pluginId": "@kbn/react-kibana-context-theme",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextThemePluginApi",
- "section": "def-public.KibanaThemeProviderProps",
+ "section": "def-common.KibanaThemeProviderProps",
"text": "KibanaThemeProviderProps"
},
" extends EuiProps<{}>"
@@ -175,7 +204,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.KibanaThemeProviderProps.theme",
+ "id": "def-common.KibanaThemeProviderProps.theme",
"type": "Object",
"tags": [],
"label": "theme",
@@ -185,9 +214,9 @@
"signature": [
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
}
],
@@ -204,7 +233,7 @@
"objects": [
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.defaultTheme",
+ "id": "def-common.defaultTheme",
"type": "Object",
"tags": [],
"label": "defaultTheme",
@@ -217,7 +246,7 @@
"children": [
{
"parentPluginId": "@kbn/react-kibana-context-theme",
- "id": "def-public.defaultTheme.darkMode",
+ "id": "def-common.defaultTheme.darkMode",
"type": "boolean",
"tags": [],
"label": "darkMode",
@@ -228,26 +257,21 @@
"path": "packages/react/kibana_context/common/index.ts",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/react-kibana-context-theme",
+ "id": "def-common.defaultTheme.name",
+ "type": "string",
+ "tags": [],
+ "label": "name",
+ "description": [],
+ "path": "packages/react/kibana_context/common/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
}
]
- },
- "server": {
- "classes": [],
- "functions": [],
- "interfaces": [],
- "enums": [],
- "misc": [],
- "objects": []
- },
- "common": {
- "classes": [],
- "functions": [],
- "interfaces": [],
- "enums": [],
- "misc": [],
- "objects": []
}
}
\ No newline at end of file
diff --git a/api_docs/kbn_react_kibana_context_theme.mdx b/api_docs/kbn_react_kibana_context_theme.mdx
index f4290911659d5..18ae8bd1ebb68 100644
--- a/api_docs/kbn_react_kibana_context_theme.mdx
+++ b/api_docs/kbn_react_kibana_context_theme.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-theme
title: "@kbn/react-kibana-context-theme"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/react-kibana-context-theme plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-theme']
---
import kbnReactKibanaContextThemeObj from './kbn_react_kibana_context_theme.devdocs.json';
@@ -21,16 +21,16 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 11 | 0 | 2 | 0 |
+| 13 | 0 | 3 | 0 |
-## Client
+## Common
### Objects
-
+
### Functions
-
+
### Interfaces
-
+
diff --git a/api_docs/kbn_react_kibana_mount.devdocs.json b/api_docs/kbn_react_kibana_mount.devdocs.json
index 7f37d6c028ca7..08cb88df1a8d1 100644
--- a/api_docs/kbn_react_kibana_mount.devdocs.json
+++ b/api_docs/kbn_react_kibana_mount.devdocs.json
@@ -268,9 +268,9 @@
", \"reportEvent\"> | undefined; theme: ",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
},
"; }"
diff --git a/api_docs/kbn_react_kibana_mount.mdx b/api_docs/kbn_react_kibana_mount.mdx
index 7f6becf1bd099..9c0366f806992 100644
--- a/api_docs/kbn_react_kibana_mount.mdx
+++ b/api_docs/kbn_react_kibana_mount.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-mount
title: "@kbn/react-kibana-mount"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/react-kibana-mount plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-mount']
---
import kbnReactKibanaMountObj from './kbn_react_kibana_mount.devdocs.json';
diff --git a/api_docs/kbn_recently_accessed.mdx b/api_docs/kbn_recently_accessed.mdx
index c5ad741ef9925..4b5d043b09b7d 100644
--- a/api_docs/kbn_recently_accessed.mdx
+++ b/api_docs/kbn_recently_accessed.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-recently-accessed
title: "@kbn/recently-accessed"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/recently-accessed plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/recently-accessed']
---
import kbnRecentlyAccessedObj from './kbn_recently_accessed.devdocs.json';
diff --git a/api_docs/kbn_repo_file_maps.mdx b/api_docs/kbn_repo_file_maps.mdx
index 39b5719ed9b16..746f934a2e0cc 100644
--- a/api_docs/kbn_repo_file_maps.mdx
+++ b/api_docs/kbn_repo_file_maps.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-file-maps
title: "@kbn/repo-file-maps"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/repo-file-maps plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-file-maps']
---
import kbnRepoFileMapsObj from './kbn_repo_file_maps.devdocs.json';
diff --git a/api_docs/kbn_repo_linter.mdx b/api_docs/kbn_repo_linter.mdx
index db7e87ec527ed..baeb2bf83af85 100644
--- a/api_docs/kbn_repo_linter.mdx
+++ b/api_docs/kbn_repo_linter.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-linter
title: "@kbn/repo-linter"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/repo-linter plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-linter']
---
import kbnRepoLinterObj from './kbn_repo_linter.devdocs.json';
diff --git a/api_docs/kbn_repo_path.mdx b/api_docs/kbn_repo_path.mdx
index dfbf4869756f1..96c23e1ee8e1f 100644
--- a/api_docs/kbn_repo_path.mdx
+++ b/api_docs/kbn_repo_path.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-path
title: "@kbn/repo-path"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/repo-path plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-path']
---
import kbnRepoPathObj from './kbn_repo_path.devdocs.json';
diff --git a/api_docs/kbn_repo_source_classifier.mdx b/api_docs/kbn_repo_source_classifier.mdx
index 6fedccfb3daa3..3568c0317a12d 100644
--- a/api_docs/kbn_repo_source_classifier.mdx
+++ b/api_docs/kbn_repo_source_classifier.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-source-classifier
title: "@kbn/repo-source-classifier"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/repo-source-classifier plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-source-classifier']
---
import kbnRepoSourceClassifierObj from './kbn_repo_source_classifier.devdocs.json';
diff --git a/api_docs/kbn_reporting_common.mdx b/api_docs/kbn_reporting_common.mdx
index b4972f5d24345..c3f78a25560f4 100644
--- a/api_docs/kbn_reporting_common.mdx
+++ b/api_docs/kbn_reporting_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-common
title: "@kbn/reporting-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-common']
---
import kbnReportingCommonObj from './kbn_reporting_common.devdocs.json';
diff --git a/api_docs/kbn_reporting_csv_share_panel.mdx b/api_docs/kbn_reporting_csv_share_panel.mdx
index 88f5d078910ac..f74eb1f5e7ffe 100644
--- a/api_docs/kbn_reporting_csv_share_panel.mdx
+++ b/api_docs/kbn_reporting_csv_share_panel.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-csv-share-panel
title: "@kbn/reporting-csv-share-panel"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-csv-share-panel plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-csv-share-panel']
---
import kbnReportingCsvSharePanelObj from './kbn_reporting_csv_share_panel.devdocs.json';
diff --git a/api_docs/kbn_reporting_export_types_csv.mdx b/api_docs/kbn_reporting_export_types_csv.mdx
index 2cc63f8d88f3c..353e32689bf68 100644
--- a/api_docs/kbn_reporting_export_types_csv.mdx
+++ b/api_docs/kbn_reporting_export_types_csv.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-csv
title: "@kbn/reporting-export-types-csv"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-export-types-csv plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-csv']
---
import kbnReportingExportTypesCsvObj from './kbn_reporting_export_types_csv.devdocs.json';
diff --git a/api_docs/kbn_reporting_export_types_csv_common.mdx b/api_docs/kbn_reporting_export_types_csv_common.mdx
index 1b4a2aa80bee1..5186ba61fc29c 100644
--- a/api_docs/kbn_reporting_export_types_csv_common.mdx
+++ b/api_docs/kbn_reporting_export_types_csv_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-csv-common
title: "@kbn/reporting-export-types-csv-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-export-types-csv-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-csv-common']
---
import kbnReportingExportTypesCsvCommonObj from './kbn_reporting_export_types_csv_common.devdocs.json';
diff --git a/api_docs/kbn_reporting_export_types_pdf.mdx b/api_docs/kbn_reporting_export_types_pdf.mdx
index 34892cb6b52e3..ee0f0050b0ca2 100644
--- a/api_docs/kbn_reporting_export_types_pdf.mdx
+++ b/api_docs/kbn_reporting_export_types_pdf.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-pdf
title: "@kbn/reporting-export-types-pdf"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-export-types-pdf plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-pdf']
---
import kbnReportingExportTypesPdfObj from './kbn_reporting_export_types_pdf.devdocs.json';
diff --git a/api_docs/kbn_reporting_export_types_pdf_common.mdx b/api_docs/kbn_reporting_export_types_pdf_common.mdx
index 6e10c89c8c272..30e1ae6f1ebd9 100644
--- a/api_docs/kbn_reporting_export_types_pdf_common.mdx
+++ b/api_docs/kbn_reporting_export_types_pdf_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-pdf-common
title: "@kbn/reporting-export-types-pdf-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-export-types-pdf-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-pdf-common']
---
import kbnReportingExportTypesPdfCommonObj from './kbn_reporting_export_types_pdf_common.devdocs.json';
diff --git a/api_docs/kbn_reporting_export_types_png.mdx b/api_docs/kbn_reporting_export_types_png.mdx
index 20748a6a8dabb..882287b076cfc 100644
--- a/api_docs/kbn_reporting_export_types_png.mdx
+++ b/api_docs/kbn_reporting_export_types_png.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-png
title: "@kbn/reporting-export-types-png"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-export-types-png plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-png']
---
import kbnReportingExportTypesPngObj from './kbn_reporting_export_types_png.devdocs.json';
diff --git a/api_docs/kbn_reporting_export_types_png_common.mdx b/api_docs/kbn_reporting_export_types_png_common.mdx
index a8719682796b6..1012e1ddbb15b 100644
--- a/api_docs/kbn_reporting_export_types_png_common.mdx
+++ b/api_docs/kbn_reporting_export_types_png_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-png-common
title: "@kbn/reporting-export-types-png-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-export-types-png-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-png-common']
---
import kbnReportingExportTypesPngCommonObj from './kbn_reporting_export_types_png_common.devdocs.json';
diff --git a/api_docs/kbn_reporting_mocks_server.mdx b/api_docs/kbn_reporting_mocks_server.mdx
index 850b2e176ade0..7883d3c8367cd 100644
--- a/api_docs/kbn_reporting_mocks_server.mdx
+++ b/api_docs/kbn_reporting_mocks_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-mocks-server
title: "@kbn/reporting-mocks-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-mocks-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-mocks-server']
---
import kbnReportingMocksServerObj from './kbn_reporting_mocks_server.devdocs.json';
diff --git a/api_docs/kbn_reporting_public.mdx b/api_docs/kbn_reporting_public.mdx
index 59963c93de580..038754dbd0401 100644
--- a/api_docs/kbn_reporting_public.mdx
+++ b/api_docs/kbn_reporting_public.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-public
title: "@kbn/reporting-public"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-public plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-public']
---
import kbnReportingPublicObj from './kbn_reporting_public.devdocs.json';
diff --git a/api_docs/kbn_reporting_server.mdx b/api_docs/kbn_reporting_server.mdx
index 1095686ffb553..1afbf0cb9b41e 100644
--- a/api_docs/kbn_reporting_server.mdx
+++ b/api_docs/kbn_reporting_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-server
title: "@kbn/reporting-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/reporting-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-server']
---
import kbnReportingServerObj from './kbn_reporting_server.devdocs.json';
diff --git a/api_docs/kbn_resizable_layout.mdx b/api_docs/kbn_resizable_layout.mdx
index 10c07154f7aba..61d06c7eb962b 100644
--- a/api_docs/kbn_resizable_layout.mdx
+++ b/api_docs/kbn_resizable_layout.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-resizable-layout
title: "@kbn/resizable-layout"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/resizable-layout plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/resizable-layout']
---
import kbnResizableLayoutObj from './kbn_resizable_layout.devdocs.json';
diff --git a/api_docs/kbn_response_ops_feature_flag_service.mdx b/api_docs/kbn_response_ops_feature_flag_service.mdx
index 808e078ac3093..7de7a7bf8ff49 100644
--- a/api_docs/kbn_response_ops_feature_flag_service.mdx
+++ b/api_docs/kbn_response_ops_feature_flag_service.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-response-ops-feature-flag-service
title: "@kbn/response-ops-feature-flag-service"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/response-ops-feature-flag-service plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/response-ops-feature-flag-service']
---
import kbnResponseOpsFeatureFlagServiceObj from './kbn_response_ops_feature_flag_service.devdocs.json';
diff --git a/api_docs/kbn_response_ops_rule_params.mdx b/api_docs/kbn_response_ops_rule_params.mdx
index 965eff400a7d7..8d4ecd41730ca 100644
--- a/api_docs/kbn_response_ops_rule_params.mdx
+++ b/api_docs/kbn_response_ops_rule_params.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-response-ops-rule-params
title: "@kbn/response-ops-rule-params"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/response-ops-rule-params plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/response-ops-rule-params']
---
import kbnResponseOpsRuleParamsObj from './kbn_response_ops_rule_params.devdocs.json';
diff --git a/api_docs/kbn_rison.mdx b/api_docs/kbn_rison.mdx
index 9a98e32eb811a..9026dc2269ed2 100644
--- a/api_docs/kbn_rison.mdx
+++ b/api_docs/kbn_rison.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rison
title: "@kbn/rison"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/rison plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rison']
---
import kbnRisonObj from './kbn_rison.devdocs.json';
diff --git a/api_docs/kbn_rollup.mdx b/api_docs/kbn_rollup.mdx
index ffdba9eede13e..fcaed7155b4ea 100644
--- a/api_docs/kbn_rollup.mdx
+++ b/api_docs/kbn_rollup.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rollup
title: "@kbn/rollup"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/rollup plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rollup']
---
import kbnRollupObj from './kbn_rollup.devdocs.json';
diff --git a/api_docs/kbn_router_to_openapispec.mdx b/api_docs/kbn_router_to_openapispec.mdx
index d5f9b4b3182d2..8319b6e34bfc8 100644
--- a/api_docs/kbn_router_to_openapispec.mdx
+++ b/api_docs/kbn_router_to_openapispec.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-router-to-openapispec
title: "@kbn/router-to-openapispec"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/router-to-openapispec plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/router-to-openapispec']
---
import kbnRouterToOpenapispecObj from './kbn_router_to_openapispec.devdocs.json';
diff --git a/api_docs/kbn_router_utils.mdx b/api_docs/kbn_router_utils.mdx
index f026bca21abf6..095bd1c3b6f34 100644
--- a/api_docs/kbn_router_utils.mdx
+++ b/api_docs/kbn_router_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-router-utils
title: "@kbn/router-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/router-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/router-utils']
---
import kbnRouterUtilsObj from './kbn_router_utils.devdocs.json';
diff --git a/api_docs/kbn_rrule.mdx b/api_docs/kbn_rrule.mdx
index 4fff58951ab38..06981705e8a05 100644
--- a/api_docs/kbn_rrule.mdx
+++ b/api_docs/kbn_rrule.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rrule
title: "@kbn/rrule"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/rrule plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rrule']
---
import kbnRruleObj from './kbn_rrule.devdocs.json';
diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx
index df850e1dcb927..946c5075f7762 100644
--- a/api_docs/kbn_rule_data_utils.mdx
+++ b/api_docs/kbn_rule_data_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils
title: "@kbn/rule-data-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/rule-data-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils']
---
import kbnRuleDataUtilsObj from './kbn_rule_data_utils.devdocs.json';
diff --git a/api_docs/kbn_saved_objects_settings.mdx b/api_docs/kbn_saved_objects_settings.mdx
index 8304fd2dc1892..58ecebd027e1c 100644
--- a/api_docs/kbn_saved_objects_settings.mdx
+++ b/api_docs/kbn_saved_objects_settings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-saved-objects-settings
title: "@kbn/saved-objects-settings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/saved-objects-settings plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/saved-objects-settings']
---
import kbnSavedObjectsSettingsObj from './kbn_saved_objects_settings.devdocs.json';
diff --git a/api_docs/kbn_screenshotting_server.mdx b/api_docs/kbn_screenshotting_server.mdx
index 81b6cf75d97d2..4606f65cf3f8e 100644
--- a/api_docs/kbn_screenshotting_server.mdx
+++ b/api_docs/kbn_screenshotting_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-screenshotting-server
title: "@kbn/screenshotting-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/screenshotting-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/screenshotting-server']
---
import kbnScreenshottingServerObj from './kbn_screenshotting_server.devdocs.json';
diff --git a/api_docs/kbn_search_api_keys_components.mdx b/api_docs/kbn_search_api_keys_components.mdx
index 036d533414151..61e0051116758 100644
--- a/api_docs/kbn_search_api_keys_components.mdx
+++ b/api_docs/kbn_search_api_keys_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-api-keys-components
title: "@kbn/search-api-keys-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-api-keys-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-api-keys-components']
---
import kbnSearchApiKeysComponentsObj from './kbn_search_api_keys_components.devdocs.json';
diff --git a/api_docs/kbn_search_api_keys_server.mdx b/api_docs/kbn_search_api_keys_server.mdx
index 596192462838e..e576e05be45b8 100644
--- a/api_docs/kbn_search_api_keys_server.mdx
+++ b/api_docs/kbn_search_api_keys_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-api-keys-server
title: "@kbn/search-api-keys-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-api-keys-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-api-keys-server']
---
import kbnSearchApiKeysServerObj from './kbn_search_api_keys_server.devdocs.json';
diff --git a/api_docs/kbn_search_api_panels.mdx b/api_docs/kbn_search_api_panels.mdx
index 1e8bd2d24054f..7b988050e45e5 100644
--- a/api_docs/kbn_search_api_panels.mdx
+++ b/api_docs/kbn_search_api_panels.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-api-panels
title: "@kbn/search-api-panels"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-api-panels plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-api-panels']
---
import kbnSearchApiPanelsObj from './kbn_search_api_panels.devdocs.json';
diff --git a/api_docs/kbn_search_connectors.mdx b/api_docs/kbn_search_connectors.mdx
index 88e1a518c3256..c5992a0d39585 100644
--- a/api_docs/kbn_search_connectors.mdx
+++ b/api_docs/kbn_search_connectors.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-connectors
title: "@kbn/search-connectors"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-connectors plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-connectors']
---
import kbnSearchConnectorsObj from './kbn_search_connectors.devdocs.json';
diff --git a/api_docs/kbn_search_errors.mdx b/api_docs/kbn_search_errors.mdx
index 731f23cc805b9..6578554198181 100644
--- a/api_docs/kbn_search_errors.mdx
+++ b/api_docs/kbn_search_errors.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-errors
title: "@kbn/search-errors"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-errors plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-errors']
---
import kbnSearchErrorsObj from './kbn_search_errors.devdocs.json';
diff --git a/api_docs/kbn_search_index_documents.devdocs.json b/api_docs/kbn_search_index_documents.devdocs.json
index 47d7e742f5e90..72f4181793656 100644
--- a/api_docs/kbn_search_index_documents.devdocs.json
+++ b/api_docs/kbn_search_index_documents.devdocs.json
@@ -333,7 +333,7 @@
"label": "Result",
"description": [],
"signature": [
- "({ metaData, fields, defaultVisibleFields, compactCard, showScore, onDocumentClick, onDocumentDelete, }: ",
+ "({ metaData, fields, defaultVisibleFields, compactCard, showScore, onDocumentClick, onDocumentDelete, hasDeleteDocumentsPrivilege, }: ",
"ResultProps",
") => React.JSX.Element"
],
@@ -346,7 +346,7 @@
"id": "def-common.Result.$1",
"type": "Object",
"tags": [],
- "label": "{\n metaData,\n fields,\n defaultVisibleFields = DEFAULT_VISIBLE_FIELDS,\n compactCard = true,\n showScore = false,\n onDocumentClick,\n onDocumentDelete,\n}",
+ "label": "{\n metaData,\n fields,\n defaultVisibleFields = DEFAULT_VISIBLE_FIELDS,\n compactCard = true,\n showScore = false,\n onDocumentClick,\n onDocumentDelete,\n hasDeleteDocumentsPrivilege,\n}",
"description": [],
"signature": [
"ResultProps"
diff --git a/api_docs/kbn_search_index_documents.mdx b/api_docs/kbn_search_index_documents.mdx
index c7522a8e4e106..663731b4c8c94 100644
--- a/api_docs/kbn_search_index_documents.mdx
+++ b/api_docs/kbn_search_index_documents.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-index-documents
title: "@kbn/search-index-documents"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-index-documents plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-index-documents']
---
import kbnSearchIndexDocumentsObj from './kbn_search_index_documents.devdocs.json';
diff --git a/api_docs/kbn_search_response_warnings.mdx b/api_docs/kbn_search_response_warnings.mdx
index b4d97f4fa8380..846d86f36d714 100644
--- a/api_docs/kbn_search_response_warnings.mdx
+++ b/api_docs/kbn_search_response_warnings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-response-warnings
title: "@kbn/search-response-warnings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-response-warnings plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-response-warnings']
---
import kbnSearchResponseWarningsObj from './kbn_search_response_warnings.devdocs.json';
diff --git a/api_docs/kbn_search_shared_ui.mdx b/api_docs/kbn_search_shared_ui.mdx
index e6351f22ea02e..c4079c031c338 100644
--- a/api_docs/kbn_search_shared_ui.mdx
+++ b/api_docs/kbn_search_shared_ui.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-shared-ui
title: "@kbn/search-shared-ui"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-shared-ui plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-shared-ui']
---
import kbnSearchSharedUiObj from './kbn_search_shared_ui.devdocs.json';
diff --git a/api_docs/kbn_search_types.mdx b/api_docs/kbn_search_types.mdx
index 5d696be7fcd5b..6783991d9f0bf 100644
--- a/api_docs/kbn_search_types.mdx
+++ b/api_docs/kbn_search_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-types
title: "@kbn/search-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/search-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-types']
---
import kbnSearchTypesObj from './kbn_search_types.devdocs.json';
diff --git a/api_docs/kbn_security_api_key_management.mdx b/api_docs/kbn_security_api_key_management.mdx
index 0ad3c6e95e6a5..1722c602451b8 100644
--- a/api_docs/kbn_security_api_key_management.mdx
+++ b/api_docs/kbn_security_api_key_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-api-key-management
title: "@kbn/security-api-key-management"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-api-key-management plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-api-key-management']
---
import kbnSecurityApiKeyManagementObj from './kbn_security_api_key_management.devdocs.json';
diff --git a/api_docs/kbn_security_authorization_core.mdx b/api_docs/kbn_security_authorization_core.mdx
index 37ede45fdddcd..f8f715bc0d53b 100644
--- a/api_docs/kbn_security_authorization_core.mdx
+++ b/api_docs/kbn_security_authorization_core.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-authorization-core
title: "@kbn/security-authorization-core"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-authorization-core plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-authorization-core']
---
import kbnSecurityAuthorizationCoreObj from './kbn_security_authorization_core.devdocs.json';
diff --git a/api_docs/kbn_security_authorization_core_common.mdx b/api_docs/kbn_security_authorization_core_common.mdx
index 08df8fcd6c68a..015542126dd71 100644
--- a/api_docs/kbn_security_authorization_core_common.mdx
+++ b/api_docs/kbn_security_authorization_core_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-authorization-core-common
title: "@kbn/security-authorization-core-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-authorization-core-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-authorization-core-common']
---
import kbnSecurityAuthorizationCoreCommonObj from './kbn_security_authorization_core_common.devdocs.json';
diff --git a/api_docs/kbn_security_form_components.mdx b/api_docs/kbn_security_form_components.mdx
index 0c64dc48025c0..e96d10a12687d 100644
--- a/api_docs/kbn_security_form_components.mdx
+++ b/api_docs/kbn_security_form_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-form-components
title: "@kbn/security-form-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-form-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-form-components']
---
import kbnSecurityFormComponentsObj from './kbn_security_form_components.devdocs.json';
diff --git a/api_docs/kbn_security_hardening.mdx b/api_docs/kbn_security_hardening.mdx
index 995f67caecd92..c90cf79223e83 100644
--- a/api_docs/kbn_security_hardening.mdx
+++ b/api_docs/kbn_security_hardening.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-hardening
title: "@kbn/security-hardening"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-hardening plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-hardening']
---
import kbnSecurityHardeningObj from './kbn_security_hardening.devdocs.json';
diff --git a/api_docs/kbn_security_plugin_types_common.mdx b/api_docs/kbn_security_plugin_types_common.mdx
index 1b3878dfb34c0..899501eb9f32f 100644
--- a/api_docs/kbn_security_plugin_types_common.mdx
+++ b/api_docs/kbn_security_plugin_types_common.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-plugin-types-common
title: "@kbn/security-plugin-types-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-plugin-types-common plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-plugin-types-common']
---
import kbnSecurityPluginTypesCommonObj from './kbn_security_plugin_types_common.devdocs.json';
diff --git a/api_docs/kbn_security_plugin_types_public.mdx b/api_docs/kbn_security_plugin_types_public.mdx
index 98f2d1fac6c9c..d2c44490a1bb0 100644
--- a/api_docs/kbn_security_plugin_types_public.mdx
+++ b/api_docs/kbn_security_plugin_types_public.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-plugin-types-public
title: "@kbn/security-plugin-types-public"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-plugin-types-public plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-plugin-types-public']
---
import kbnSecurityPluginTypesPublicObj from './kbn_security_plugin_types_public.devdocs.json';
diff --git a/api_docs/kbn_security_plugin_types_server.mdx b/api_docs/kbn_security_plugin_types_server.mdx
index 5f6bd82fd14df..213eff3dddf6b 100644
--- a/api_docs/kbn_security_plugin_types_server.mdx
+++ b/api_docs/kbn_security_plugin_types_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-plugin-types-server
title: "@kbn/security-plugin-types-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-plugin-types-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-plugin-types-server']
---
import kbnSecurityPluginTypesServerObj from './kbn_security_plugin_types_server.devdocs.json';
diff --git a/api_docs/kbn_security_role_management_model.mdx b/api_docs/kbn_security_role_management_model.mdx
index 06a735bee936c..477f3b6831d78 100644
--- a/api_docs/kbn_security_role_management_model.mdx
+++ b/api_docs/kbn_security_role_management_model.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-role-management-model
title: "@kbn/security-role-management-model"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-role-management-model plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-role-management-model']
---
import kbnSecurityRoleManagementModelObj from './kbn_security_role_management_model.devdocs.json';
diff --git a/api_docs/kbn_security_solution_distribution_bar.mdx b/api_docs/kbn_security_solution_distribution_bar.mdx
index 4526e264867df..4cc577dd55b4b 100644
--- a/api_docs/kbn_security_solution_distribution_bar.mdx
+++ b/api_docs/kbn_security_solution_distribution_bar.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-distribution-bar
title: "@kbn/security-solution-distribution-bar"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-solution-distribution-bar plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-distribution-bar']
---
import kbnSecuritySolutionDistributionBarObj from './kbn_security_solution_distribution_bar.devdocs.json';
diff --git a/api_docs/kbn_security_solution_features.mdx b/api_docs/kbn_security_solution_features.mdx
index d67453d983c19..f3179e59ab39f 100644
--- a/api_docs/kbn_security_solution_features.mdx
+++ b/api_docs/kbn_security_solution_features.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-features
title: "@kbn/security-solution-features"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-solution-features plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-features']
---
import kbnSecuritySolutionFeaturesObj from './kbn_security_solution_features.devdocs.json';
diff --git a/api_docs/kbn_security_solution_navigation.mdx b/api_docs/kbn_security_solution_navigation.mdx
index 1af308749fdc3..c25a1b05e1cbc 100644
--- a/api_docs/kbn_security_solution_navigation.mdx
+++ b/api_docs/kbn_security_solution_navigation.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-navigation
title: "@kbn/security-solution-navigation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-solution-navigation plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-navigation']
---
import kbnSecuritySolutionNavigationObj from './kbn_security_solution_navigation.devdocs.json';
diff --git a/api_docs/kbn_security_solution_side_nav.mdx b/api_docs/kbn_security_solution_side_nav.mdx
index dbf0f58fdff2c..523d146d2fb5b 100644
--- a/api_docs/kbn_security_solution_side_nav.mdx
+++ b/api_docs/kbn_security_solution_side_nav.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-side-nav
title: "@kbn/security-solution-side-nav"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-solution-side-nav plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-side-nav']
---
import kbnSecuritySolutionSideNavObj from './kbn_security_solution_side_nav.devdocs.json';
diff --git a/api_docs/kbn_security_solution_storybook_config.mdx b/api_docs/kbn_security_solution_storybook_config.mdx
index 75e8b0e47fbfd..5902142affea1 100644
--- a/api_docs/kbn_security_solution_storybook_config.mdx
+++ b/api_docs/kbn_security_solution_storybook_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-storybook-config
title: "@kbn/security-solution-storybook-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-solution-storybook-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-storybook-config']
---
import kbnSecuritySolutionStorybookConfigObj from './kbn_security_solution_storybook_config.devdocs.json';
diff --git a/api_docs/kbn_security_ui_components.mdx b/api_docs/kbn_security_ui_components.mdx
index 942dec137a38d..aa7487f0bc657 100644
--- a/api_docs/kbn_security_ui_components.mdx
+++ b/api_docs/kbn_security_ui_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-ui-components
title: "@kbn/security-ui-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/security-ui-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-ui-components']
---
import kbnSecurityUiComponentsObj from './kbn_security_ui_components.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx
index 5a8d5318e6d98..48a49229dd27e 100644
--- a/api_docs/kbn_securitysolution_autocomplete.mdx
+++ b/api_docs/kbn_securitysolution_autocomplete.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete
title: "@kbn/securitysolution-autocomplete"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-autocomplete plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete']
---
import kbnSecuritysolutionAutocompleteObj from './kbn_securitysolution_autocomplete.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_data_table.mdx b/api_docs/kbn_securitysolution_data_table.mdx
index 705ed6c66e59c..69653a9cb55e6 100644
--- a/api_docs/kbn_securitysolution_data_table.mdx
+++ b/api_docs/kbn_securitysolution_data_table.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-data-table
title: "@kbn/securitysolution-data-table"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-data-table plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-data-table']
---
import kbnSecuritysolutionDataTableObj from './kbn_securitysolution_data_table.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_ecs.mdx b/api_docs/kbn_securitysolution_ecs.mdx
index d5a3174746294..bfdff85393751 100644
--- a/api_docs/kbn_securitysolution_ecs.mdx
+++ b/api_docs/kbn_securitysolution_ecs.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-ecs
title: "@kbn/securitysolution-ecs"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-ecs plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-ecs']
---
import kbnSecuritysolutionEcsObj from './kbn_securitysolution_ecs.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx
index 14fce7f410372..1fae7a7cf0730 100644
--- a/api_docs/kbn_securitysolution_es_utils.mdx
+++ b/api_docs/kbn_securitysolution_es_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils
title: "@kbn/securitysolution-es-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-es-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils']
---
import kbnSecuritysolutionEsUtilsObj from './kbn_securitysolution_es_utils.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_exception_list_components.mdx b/api_docs/kbn_securitysolution_exception_list_components.mdx
index 99d3ec027f265..040d9c112624a 100644
--- a/api_docs/kbn_securitysolution_exception_list_components.mdx
+++ b/api_docs/kbn_securitysolution_exception_list_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-exception-list-components
title: "@kbn/securitysolution-exception-list-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-exception-list-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-exception-list-components']
---
import kbnSecuritysolutionExceptionListComponentsObj from './kbn_securitysolution_exception_list_components.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx
index 2881876ff6aa9..480c5d63613ca 100644
--- a/api_docs/kbn_securitysolution_hook_utils.mdx
+++ b/api_docs/kbn_securitysolution_hook_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils
title: "@kbn/securitysolution-hook-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-hook-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils']
---
import kbnSecuritysolutionHookUtilsObj from './kbn_securitysolution_hook_utils.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx
index 56c503eb9845d..2e880ce5c6690 100644
--- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx
+++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types
title: "@kbn/securitysolution-io-ts-alerting-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types']
---
import kbnSecuritysolutionIoTsAlertingTypesObj from './kbn_securitysolution_io_ts_alerting_types.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx
index b9b89a2eda30d..59d2e2f88f63f 100644
--- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx
+++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types
title: "@kbn/securitysolution-io-ts-list-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-io-ts-list-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types']
---
import kbnSecuritysolutionIoTsListTypesObj from './kbn_securitysolution_io_ts_list_types.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx
index 8369c4f99c4d6..752b5d3f8b7ac 100644
--- a/api_docs/kbn_securitysolution_io_ts_types.mdx
+++ b/api_docs/kbn_securitysolution_io_ts_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types
title: "@kbn/securitysolution-io-ts-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-io-ts-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types']
---
import kbnSecuritysolutionIoTsTypesObj from './kbn_securitysolution_io_ts_types.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx
index 4f0b89af2e0db..d43572d3671cc 100644
--- a/api_docs/kbn_securitysolution_io_ts_utils.mdx
+++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils
title: "@kbn/securitysolution-io-ts-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-io-ts-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils']
---
import kbnSecuritysolutionIoTsUtilsObj from './kbn_securitysolution_io_ts_utils.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx
index 62533d69fda85..c87c9a7ad6a69 100644
--- a/api_docs/kbn_securitysolution_list_api.mdx
+++ b/api_docs/kbn_securitysolution_list_api.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api
title: "@kbn/securitysolution-list-api"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-list-api plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api']
---
import kbnSecuritysolutionListApiObj from './kbn_securitysolution_list_api.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_list_constants.devdocs.json b/api_docs/kbn_securitysolution_list_constants.devdocs.json
index 0723d3a24ca19..2b2e1776831a1 100644
--- a/api_docs/kbn_securitysolution_list_constants.devdocs.json
+++ b/api_docs/kbn_securitysolution_list_constants.devdocs.json
@@ -91,14 +91,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts"
},
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts"
- },
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts"
- },
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/scripts/endpoint/blocklists/index.ts"
@@ -295,14 +287,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts"
},
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts"
- },
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts"
- },
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/scripts/endpoint/event_filters/index.ts"
@@ -451,14 +435,6 @@
"plugin": "lists",
"path": "x-pack/plugins/lists/server/services/exception_lists/get_exception_list_summary.test.ts"
},
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts"
- },
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts"
- },
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/common/endpoint/data_generators/host_isolation_exception_generator.ts"
@@ -732,14 +708,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts"
},
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/trusted_app_validator.ts"
- },
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/trusted_app_validator.ts"
- },
{
"plugin": "lists",
"path": "x-pack/plugins/lists/server/saved_objects/migrations.test.ts"
@@ -776,14 +744,6 @@
"plugin": "lists",
"path": "x-pack/plugins/lists/server/saved_objects/migrations.test.ts"
},
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts"
- },
- {
- "plugin": "securitySolution",
- "path": "x-pack/plugins/security_solution/common/endpoint/data_generators/exceptions_list_item_generator.ts"
- },
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/mocks/trusted_apps_http_mocks.ts"
diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx
index 40e344ee55bbf..b6c4dfc52234c 100644
--- a/api_docs/kbn_securitysolution_list_constants.mdx
+++ b/api_docs/kbn_securitysolution_list_constants.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants
title: "@kbn/securitysolution-list-constants"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-list-constants plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants']
---
import kbnSecuritysolutionListConstantsObj from './kbn_securitysolution_list_constants.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx
index dbde7f49ea403..59bc21dea6024 100644
--- a/api_docs/kbn_securitysolution_list_hooks.mdx
+++ b/api_docs/kbn_securitysolution_list_hooks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks
title: "@kbn/securitysolution-list-hooks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-list-hooks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks']
---
import kbnSecuritysolutionListHooksObj from './kbn_securitysolution_list_hooks.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx
index 6ef72db4f3901..a0f7dd123815a 100644
--- a/api_docs/kbn_securitysolution_list_utils.mdx
+++ b/api_docs/kbn_securitysolution_list_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils
title: "@kbn/securitysolution-list-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-list-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils']
---
import kbnSecuritysolutionListUtilsObj from './kbn_securitysolution_list_utils.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx
index 9fcb096edc345..78d2ea6f9dd59 100644
--- a/api_docs/kbn_securitysolution_rules.mdx
+++ b/api_docs/kbn_securitysolution_rules.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules
title: "@kbn/securitysolution-rules"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-rules plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules']
---
import kbnSecuritysolutionRulesObj from './kbn_securitysolution_rules.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx
index d1bc853d841a2..c790ecaca5dc4 100644
--- a/api_docs/kbn_securitysolution_t_grid.mdx
+++ b/api_docs/kbn_securitysolution_t_grid.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid
title: "@kbn/securitysolution-t-grid"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-t-grid plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid']
---
import kbnSecuritysolutionTGridObj from './kbn_securitysolution_t_grid.devdocs.json';
diff --git a/api_docs/kbn_securitysolution_utils.devdocs.json b/api_docs/kbn_securitysolution_utils.devdocs.json
index dc082ea47606d..7dbb4b59056c6 100644
--- a/api_docs/kbn_securitysolution_utils.devdocs.json
+++ b/api_docs/kbn_securitysolution_utils.devdocs.json
@@ -1042,7 +1042,7 @@
"label": "TrustedAppConditionEntryField",
"description": [],
"signature": [
- "\"process.hash.*\" | \"process.executable.caseless\" | \"process.Ext.code_signature\""
+ "\"process.hash.*\" | \"process.executable.caseless\" | \"process.Ext.code_signature\" | \"process.code_signature\""
],
"path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx
index 98122aa89f2e8..9637b9ca23433 100644
--- a/api_docs/kbn_securitysolution_utils.mdx
+++ b/api_docs/kbn_securitysolution_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils
title: "@kbn/securitysolution-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/securitysolution-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils']
---
import kbnSecuritysolutionUtilsObj from './kbn_securitysolution_utils.devdocs.json';
diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx
index 73c3838711717..ad7aba34e8d52 100644
--- a/api_docs/kbn_server_http_tools.mdx
+++ b/api_docs/kbn_server_http_tools.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools
title: "@kbn/server-http-tools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/server-http-tools plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools']
---
import kbnServerHttpToolsObj from './kbn_server_http_tools.devdocs.json';
diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx
index 2c8365a082419..9251648d483e4 100644
--- a/api_docs/kbn_server_route_repository.mdx
+++ b/api_docs/kbn_server_route_repository.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository
title: "@kbn/server-route-repository"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/server-route-repository plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository']
---
import kbnServerRouteRepositoryObj from './kbn_server_route_repository.devdocs.json';
diff --git a/api_docs/kbn_server_route_repository_client.mdx b/api_docs/kbn_server_route_repository_client.mdx
index 43cb50b483331..08e844eff3f21 100644
--- a/api_docs/kbn_server_route_repository_client.mdx
+++ b/api_docs/kbn_server_route_repository_client.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository-client
title: "@kbn/server-route-repository-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/server-route-repository-client plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository-client']
---
import kbnServerRouteRepositoryClientObj from './kbn_server_route_repository_client.devdocs.json';
diff --git a/api_docs/kbn_server_route_repository_utils.mdx b/api_docs/kbn_server_route_repository_utils.mdx
index 8c132ec37fb07..7baed599e0a66 100644
--- a/api_docs/kbn_server_route_repository_utils.mdx
+++ b/api_docs/kbn_server_route_repository_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository-utils
title: "@kbn/server-route-repository-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/server-route-repository-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository-utils']
---
import kbnServerRouteRepositoryUtilsObj from './kbn_server_route_repository_utils.devdocs.json';
diff --git a/api_docs/kbn_serverless_common_settings.mdx b/api_docs/kbn_serverless_common_settings.mdx
index 50ca7e82d3a3c..5fa20acb2c9c2 100644
--- a/api_docs/kbn_serverless_common_settings.mdx
+++ b/api_docs/kbn_serverless_common_settings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-common-settings
title: "@kbn/serverless-common-settings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/serverless-common-settings plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-common-settings']
---
import kbnServerlessCommonSettingsObj from './kbn_serverless_common_settings.devdocs.json';
diff --git a/api_docs/kbn_serverless_observability_settings.mdx b/api_docs/kbn_serverless_observability_settings.mdx
index 544642a2fe140..a1d4f1ebf7c76 100644
--- a/api_docs/kbn_serverless_observability_settings.mdx
+++ b/api_docs/kbn_serverless_observability_settings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-observability-settings
title: "@kbn/serverless-observability-settings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/serverless-observability-settings plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-observability-settings']
---
import kbnServerlessObservabilitySettingsObj from './kbn_serverless_observability_settings.devdocs.json';
diff --git a/api_docs/kbn_serverless_project_switcher.mdx b/api_docs/kbn_serverless_project_switcher.mdx
index 2815424237526..40f536f5db04c 100644
--- a/api_docs/kbn_serverless_project_switcher.mdx
+++ b/api_docs/kbn_serverless_project_switcher.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-project-switcher
title: "@kbn/serverless-project-switcher"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/serverless-project-switcher plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-project-switcher']
---
import kbnServerlessProjectSwitcherObj from './kbn_serverless_project_switcher.devdocs.json';
diff --git a/api_docs/kbn_serverless_search_settings.mdx b/api_docs/kbn_serverless_search_settings.mdx
index ae047892e01c8..eefe6dfe43c07 100644
--- a/api_docs/kbn_serverless_search_settings.mdx
+++ b/api_docs/kbn_serverless_search_settings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-search-settings
title: "@kbn/serverless-search-settings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/serverless-search-settings plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-search-settings']
---
import kbnServerlessSearchSettingsObj from './kbn_serverless_search_settings.devdocs.json';
diff --git a/api_docs/kbn_serverless_security_settings.mdx b/api_docs/kbn_serverless_security_settings.mdx
index fc747df33f909..f0043ba81718b 100644
--- a/api_docs/kbn_serverless_security_settings.mdx
+++ b/api_docs/kbn_serverless_security_settings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-security-settings
title: "@kbn/serverless-security-settings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/serverless-security-settings plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-security-settings']
---
import kbnServerlessSecuritySettingsObj from './kbn_serverless_security_settings.devdocs.json';
diff --git a/api_docs/kbn_serverless_storybook_config.mdx b/api_docs/kbn_serverless_storybook_config.mdx
index 661e28b4a1b3d..573b940b664f8 100644
--- a/api_docs/kbn_serverless_storybook_config.mdx
+++ b/api_docs/kbn_serverless_storybook_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-storybook-config
title: "@kbn/serverless-storybook-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/serverless-storybook-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-storybook-config']
---
import kbnServerlessStorybookConfigObj from './kbn_serverless_storybook_config.devdocs.json';
diff --git a/api_docs/kbn_shared_svg.mdx b/api_docs/kbn_shared_svg.mdx
index 59db42d9f101e..7318743c1fa23 100644
--- a/api_docs/kbn_shared_svg.mdx
+++ b/api_docs/kbn_shared_svg.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-svg
title: "@kbn/shared-svg"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-svg plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-svg']
---
import kbnSharedSvgObj from './kbn_shared_svg.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_avatar_solution.mdx b/api_docs/kbn_shared_ux_avatar_solution.mdx
index d8a50db6705bb..1f56ef696cc4d 100644
--- a/api_docs/kbn_shared_ux_avatar_solution.mdx
+++ b/api_docs/kbn_shared_ux_avatar_solution.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-solution
title: "@kbn/shared-ux-avatar-solution"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-avatar-solution plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-solution']
---
import kbnSharedUxAvatarSolutionObj from './kbn_shared_ux_avatar_solution.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx
index 7266f6453b482..1dda7ad1df6b7 100644
--- a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx
+++ b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen
title: "@kbn/shared-ux-button-exit-full-screen"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-button-exit-full-screen plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen']
---
import kbnSharedUxButtonExitFullScreenObj from './kbn_shared_ux_button_exit_full_screen.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx
index 457844994ecb1..12dffe58bd719 100644
--- a/api_docs/kbn_shared_ux_button_toolbar.mdx
+++ b/api_docs/kbn_shared_ux_button_toolbar.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar
title: "@kbn/shared-ux-button-toolbar"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-button-toolbar plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar']
---
import kbnSharedUxButtonToolbarObj from './kbn_shared_ux_button_toolbar.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx
index c24ba1f4f292f..b7b5d81db5e0f 100644
--- a/api_docs/kbn_shared_ux_card_no_data.mdx
+++ b/api_docs/kbn_shared_ux_card_no_data.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data
title: "@kbn/shared-ux-card-no-data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-card-no-data plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data']
---
import kbnSharedUxCardNoDataObj from './kbn_shared_ux_card_no_data.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx
index c17f78db64d3f..181651e0f070d 100644
--- a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx
+++ b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data-mocks
title: "@kbn/shared-ux-card-no-data-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-card-no-data-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data-mocks']
---
import kbnSharedUxCardNoDataMocksObj from './kbn_shared_ux_card_no_data_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_chrome_navigation.mdx b/api_docs/kbn_shared_ux_chrome_navigation.mdx
index 2d17490c2cb52..e13ed972a270b 100644
--- a/api_docs/kbn_shared_ux_chrome_navigation.mdx
+++ b/api_docs/kbn_shared_ux_chrome_navigation.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-chrome-navigation
title: "@kbn/shared-ux-chrome-navigation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-chrome-navigation plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-chrome-navigation']
---
import kbnSharedUxChromeNavigationObj from './kbn_shared_ux_chrome_navigation.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_error_boundary.mdx b/api_docs/kbn_shared_ux_error_boundary.mdx
index f83f20df458a9..513f3b43a27d7 100644
--- a/api_docs/kbn_shared_ux_error_boundary.mdx
+++ b/api_docs/kbn_shared_ux_error_boundary.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-error-boundary
title: "@kbn/shared-ux-error-boundary"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-error-boundary plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-error-boundary']
---
import kbnSharedUxErrorBoundaryObj from './kbn_shared_ux_error_boundary.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_file_context.mdx b/api_docs/kbn_shared_ux_file_context.mdx
index 04cbd2c54472a..99d28e41826a0 100644
--- a/api_docs/kbn_shared_ux_file_context.mdx
+++ b/api_docs/kbn_shared_ux_file_context.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-context
title: "@kbn/shared-ux-file-context"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-file-context plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-context']
---
import kbnSharedUxFileContextObj from './kbn_shared_ux_file_context.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_file_image.mdx b/api_docs/kbn_shared_ux_file_image.mdx
index 663a54a6749ea..39b714b6dac28 100644
--- a/api_docs/kbn_shared_ux_file_image.mdx
+++ b/api_docs/kbn_shared_ux_file_image.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image
title: "@kbn/shared-ux-file-image"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-file-image plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-image']
---
import kbnSharedUxFileImageObj from './kbn_shared_ux_file_image.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_file_image_mocks.mdx b/api_docs/kbn_shared_ux_file_image_mocks.mdx
index 65affb70d66cf..41c98a856fa0b 100644
--- a/api_docs/kbn_shared_ux_file_image_mocks.mdx
+++ b/api_docs/kbn_shared_ux_file_image_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image-mocks
title: "@kbn/shared-ux-file-image-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-file-image-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-image-mocks']
---
import kbnSharedUxFileImageMocksObj from './kbn_shared_ux_file_image_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_file_mocks.mdx b/api_docs/kbn_shared_ux_file_mocks.mdx
index 7a356936fe50a..d776a9e4882bf 100644
--- a/api_docs/kbn_shared_ux_file_mocks.mdx
+++ b/api_docs/kbn_shared_ux_file_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-mocks
title: "@kbn/shared-ux-file-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-file-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-mocks']
---
import kbnSharedUxFileMocksObj from './kbn_shared_ux_file_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_file_picker.mdx b/api_docs/kbn_shared_ux_file_picker.mdx
index 599949cbd643a..38a7b7cd57660 100644
--- a/api_docs/kbn_shared_ux_file_picker.mdx
+++ b/api_docs/kbn_shared_ux_file_picker.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-picker
title: "@kbn/shared-ux-file-picker"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-file-picker plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-picker']
---
import kbnSharedUxFilePickerObj from './kbn_shared_ux_file_picker.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_file_types.mdx b/api_docs/kbn_shared_ux_file_types.mdx
index 4747f153ae922..c492a4b0cc47a 100644
--- a/api_docs/kbn_shared_ux_file_types.mdx
+++ b/api_docs/kbn_shared_ux_file_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-types
title: "@kbn/shared-ux-file-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-file-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-types']
---
import kbnSharedUxFileTypesObj from './kbn_shared_ux_file_types.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_file_upload.mdx b/api_docs/kbn_shared_ux_file_upload.mdx
index a3dbf78873d9e..25796de07ba76 100644
--- a/api_docs/kbn_shared_ux_file_upload.mdx
+++ b/api_docs/kbn_shared_ux_file_upload.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-upload
title: "@kbn/shared-ux-file-upload"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-file-upload plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-upload']
---
import kbnSharedUxFileUploadObj from './kbn_shared_ux_file_upload.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_file_util.mdx b/api_docs/kbn_shared_ux_file_util.mdx
index e609f5c3af831..612b80b339754 100644
--- a/api_docs/kbn_shared_ux_file_util.mdx
+++ b/api_docs/kbn_shared_ux_file_util.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-util
title: "@kbn/shared-ux-file-util"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-file-util plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-util']
---
import kbnSharedUxFileUtilObj from './kbn_shared_ux_file_util.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_link_redirect_app.mdx b/api_docs/kbn_shared_ux_link_redirect_app.mdx
index 2599e01d32546..f241be306e2c6 100644
--- a/api_docs/kbn_shared_ux_link_redirect_app.mdx
+++ b/api_docs/kbn_shared_ux_link_redirect_app.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app
title: "@kbn/shared-ux-link-redirect-app"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-link-redirect-app plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-link-redirect-app']
---
import kbnSharedUxLinkRedirectAppObj from './kbn_shared_ux_link_redirect_app.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx
index 22a6547420861..bd51a7c0a5beb 100644
--- a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx
+++ b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app-mocks
title: "@kbn/shared-ux-link-redirect-app-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-link-redirect-app-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-link-redirect-app-mocks']
---
import kbnSharedUxLinkRedirectAppMocksObj from './kbn_shared_ux_link_redirect_app_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_markdown.mdx b/api_docs/kbn_shared_ux_markdown.mdx
index 405fe257bf37e..3efe48b48af3e 100644
--- a/api_docs/kbn_shared_ux_markdown.mdx
+++ b/api_docs/kbn_shared_ux_markdown.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown
title: "@kbn/shared-ux-markdown"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-markdown plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-markdown']
---
import kbnSharedUxMarkdownObj from './kbn_shared_ux_markdown.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_markdown_mocks.mdx b/api_docs/kbn_shared_ux_markdown_mocks.mdx
index 79451fb85674e..ae6c16ace663b 100644
--- a/api_docs/kbn_shared_ux_markdown_mocks.mdx
+++ b/api_docs/kbn_shared_ux_markdown_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown-mocks
title: "@kbn/shared-ux-markdown-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-markdown-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-markdown-mocks']
---
import kbnSharedUxMarkdownMocksObj from './kbn_shared_ux_markdown_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx
index e0006155b1c1f..d6d913d3e6a81 100644
--- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx
+++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data
title: "@kbn/shared-ux-page-analytics-no-data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-analytics-no-data plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data']
---
import kbnSharedUxPageAnalyticsNoDataObj from './kbn_shared_ux_page_analytics_no_data.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx
index 247f2b06bf9d0..6992f6bf41fbe 100644
--- a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx
+++ b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data-mocks
title: "@kbn/shared-ux-page-analytics-no-data-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-analytics-no-data-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data-mocks']
---
import kbnSharedUxPageAnalyticsNoDataMocksObj from './kbn_shared_ux_page_analytics_no_data_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx
index fc593be4bdc69..1ec876462ab87 100644
--- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx
+++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data
title: "@kbn/shared-ux-page-kibana-no-data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-kibana-no-data plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data']
---
import kbnSharedUxPageKibanaNoDataObj from './kbn_shared_ux_page_kibana_no_data.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx
index 84019dd397182..0bd1cb9503d0f 100644
--- a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx
+++ b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data-mocks
title: "@kbn/shared-ux-page-kibana-no-data-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-kibana-no-data-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data-mocks']
---
import kbnSharedUxPageKibanaNoDataMocksObj from './kbn_shared_ux_page_kibana_no_data_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_kibana_template.mdx b/api_docs/kbn_shared_ux_page_kibana_template.mdx
index d184eeef6fd2a..8f4ab699ba811 100644
--- a/api_docs/kbn_shared_ux_page_kibana_template.mdx
+++ b/api_docs/kbn_shared_ux_page_kibana_template.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template
title: "@kbn/shared-ux-page-kibana-template"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-kibana-template plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-template']
---
import kbnSharedUxPageKibanaTemplateObj from './kbn_shared_ux_page_kibana_template.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx
index ce29727bf3771..ce922e469aaa8 100644
--- a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx
+++ b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template-mocks
title: "@kbn/shared-ux-page-kibana-template-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-kibana-template-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-template-mocks']
---
import kbnSharedUxPageKibanaTemplateMocksObj from './kbn_shared_ux_page_kibana_template_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_no_data.mdx b/api_docs/kbn_shared_ux_page_no_data.mdx
index f749e64ade026..ae5b222ff8219 100644
--- a/api_docs/kbn_shared_ux_page_no_data.mdx
+++ b/api_docs/kbn_shared_ux_page_no_data.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data
title: "@kbn/shared-ux-page-no-data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-no-data plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data']
---
import kbnSharedUxPageNoDataObj from './kbn_shared_ux_page_no_data.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_no_data_config.mdx b/api_docs/kbn_shared_ux_page_no_data_config.mdx
index 58b1c2f013878..816206d9a88f8 100644
--- a/api_docs/kbn_shared_ux_page_no_data_config.mdx
+++ b/api_docs/kbn_shared_ux_page_no_data_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config
title: "@kbn/shared-ux-page-no-data-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-no-data-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-config']
---
import kbnSharedUxPageNoDataConfigObj from './kbn_shared_ux_page_no_data_config.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx
index 0c6ee134f897c..dc97819a52142 100644
--- a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx
+++ b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config-mocks
title: "@kbn/shared-ux-page-no-data-config-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-no-data-config-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-config-mocks']
---
import kbnSharedUxPageNoDataConfigMocksObj from './kbn_shared_ux_page_no_data_config_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx
index 19410e0db528b..36cac0f02a973 100644
--- a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx
+++ b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-mocks
title: "@kbn/shared-ux-page-no-data-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-no-data-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-mocks']
---
import kbnSharedUxPageNoDataMocksObj from './kbn_shared_ux_page_no_data_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_page_solution_nav.mdx b/api_docs/kbn_shared_ux_page_solution_nav.mdx
index e15f2ec8ada8c..86f21ab6a8f35 100644
--- a/api_docs/kbn_shared_ux_page_solution_nav.mdx
+++ b/api_docs/kbn_shared_ux_page_solution_nav.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-solution-nav
title: "@kbn/shared-ux-page-solution-nav"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-page-solution-nav plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-solution-nav']
---
import kbnSharedUxPageSolutionNavObj from './kbn_shared_ux_page_solution_nav.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx
index c6b322472d40f..59032a0a26de5 100644
--- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx
+++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views
title: "@kbn/shared-ux-prompt-no-data-views"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-prompt-no-data-views plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views']
---
import kbnSharedUxPromptNoDataViewsObj from './kbn_shared_ux_prompt_no_data_views.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx
index 133317adb1ed5..3e14908f62104 100644
--- a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx
+++ b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views-mocks
title: "@kbn/shared-ux-prompt-no-data-views-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-prompt-no-data-views-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views-mocks']
---
import kbnSharedUxPromptNoDataViewsMocksObj from './kbn_shared_ux_prompt_no_data_views_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_prompt_not_found.mdx b/api_docs/kbn_shared_ux_prompt_not_found.mdx
index 04a4869262837..22d6ebd07d476 100644
--- a/api_docs/kbn_shared_ux_prompt_not_found.mdx
+++ b/api_docs/kbn_shared_ux_prompt_not_found.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-not-found
title: "@kbn/shared-ux-prompt-not-found"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-prompt-not-found plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-not-found']
---
import kbnSharedUxPromptNotFoundObj from './kbn_shared_ux_prompt_not_found.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_router.mdx b/api_docs/kbn_shared_ux_router.mdx
index 59d0de1e6856b..999e4996731a0 100644
--- a/api_docs/kbn_shared_ux_router.mdx
+++ b/api_docs/kbn_shared_ux_router.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router
title: "@kbn/shared-ux-router"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-router plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router']
---
import kbnSharedUxRouterObj from './kbn_shared_ux_router.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_router_mocks.mdx b/api_docs/kbn_shared_ux_router_mocks.mdx
index a8379d6e8c0b3..e2c9e92483dd7 100644
--- a/api_docs/kbn_shared_ux_router_mocks.mdx
+++ b/api_docs/kbn_shared_ux_router_mocks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router-mocks
title: "@kbn/shared-ux-router-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-router-mocks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router-mocks']
---
import kbnSharedUxRouterMocksObj from './kbn_shared_ux_router_mocks.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_storybook_config.mdx b/api_docs/kbn_shared_ux_storybook_config.mdx
index 24e391712caa4..ad68ebb50c23a 100644
--- a/api_docs/kbn_shared_ux_storybook_config.mdx
+++ b/api_docs/kbn_shared_ux_storybook_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-config
title: "@kbn/shared-ux-storybook-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-storybook-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-config']
---
import kbnSharedUxStorybookConfigObj from './kbn_shared_ux_storybook_config.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_storybook_mock.mdx b/api_docs/kbn_shared_ux_storybook_mock.mdx
index 57e77f3e0cb6d..5a62b599fc9e6 100644
--- a/api_docs/kbn_shared_ux_storybook_mock.mdx
+++ b/api_docs/kbn_shared_ux_storybook_mock.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-mock
title: "@kbn/shared-ux-storybook-mock"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-storybook-mock plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-mock']
---
import kbnSharedUxStorybookMockObj from './kbn_shared_ux_storybook_mock.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_tabbed_modal.mdx b/api_docs/kbn_shared_ux_tabbed_modal.mdx
index 68a299a636696..499034cae475f 100644
--- a/api_docs/kbn_shared_ux_tabbed_modal.mdx
+++ b/api_docs/kbn_shared_ux_tabbed_modal.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-tabbed-modal
title: "@kbn/shared-ux-tabbed-modal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-tabbed-modal plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-tabbed-modal']
---
import kbnSharedUxTabbedModalObj from './kbn_shared_ux_tabbed_modal.devdocs.json';
diff --git a/api_docs/kbn_shared_ux_table_persist.devdocs.json b/api_docs/kbn_shared_ux_table_persist.devdocs.json
index 470b02bafd6c9..1abcdffc47de4 100644
--- a/api_docs/kbn_shared_ux_table_persist.devdocs.json
+++ b/api_docs/kbn_shared_ux_table_persist.devdocs.json
@@ -29,12 +29,134 @@
"\nA hook that stores and retrieves from local storage the table page size and sort criteria.\nReturns the persisting page size and sort and the onTableChange handler that should be passed\nas props to an Eui table component."
],
"signature": [
- "({ tableId, customOnTableChange, initialSort, initialPageSize, pageSizeOptions, }: ",
+ "(props: ",
+ "EuiTablePersistProps",
+ " & { initialSort: ",
+ "PropertySort",
+ "; }) => { sorting: { sort: ",
+ "PropertySort",
+ "; }; pageSize: number; onTableChange: (nextValues: ",
+ "CriteriaWithPagination",
+ ") => void; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/use_table_persist.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.useEuiTablePersist.$1",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "props",
+ "description": [],
+ "signature": [
+ "EuiTablePersistProps",
+ " & { initialSort: ",
+ "PropertySort",
+ "; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/use_table_persist.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.useEuiTablePersist",
+ "type": "Function",
+ "tags": [],
+ "label": "useEuiTablePersist",
+ "description": [],
+ "signature": [
+ "(props: ",
+ "EuiTablePersistProps",
+ " & { initialSort?: undefined; }) => { sorting: true; pageSize: number; onTableChange: (nextValues: ",
+ "CriteriaWithPagination",
+ ") => void; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/use_table_persist.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.useEuiTablePersist.$1",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "props",
+ "description": [],
+ "signature": [
+ "EuiTablePersistProps",
+ " & { initialSort?: undefined; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/use_table_persist.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.useEuiTablePersist",
+ "type": "Function",
+ "tags": [],
+ "label": "useEuiTablePersist",
+ "description": [],
+ "signature": [
+ "(props: ",
+ "EuiTablePersistProps",
+ ") => { sorting: true | { sort: ",
+ "PropertySort",
+ "; }; pageSize: number; onTableChange: (nextValues: ",
+ "CriteriaWithPagination",
+ ") => void; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/use_table_persist.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.useEuiTablePersist.$1",
+ "type": "Object",
+ "tags": [],
+ "label": "props",
+ "description": [],
+ "signature": [
+ "EuiTablePersistProps",
+ ""
+ ],
+ "path": "packages/shared-ux/table_persist/src/use_table_persist.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.useEuiTablePersist",
+ "type": "Function",
+ "tags": [],
+ "label": "useEuiTablePersist",
+ "description": [],
+ "signature": [
+ "({\n tableId,\n customOnTableChange,\n initialSort,\n initialPageSize,\n pageSizeOptions,\n}: ",
"EuiTablePersistProps",
") => { pageSize: number; sorting: boolean | { sort: ",
"PropertySort",
"; }; onTableChange: (nextValues: ",
- "Criteria",
+ "CriteriaWithPagination",
") => void; }"
],
"path": "packages/shared-ux/table_persist/src/use_table_persist.ts",
@@ -60,9 +182,144 @@
],
"returnComment": [],
"initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.withEuiTablePersist",
+ "type": "Function",
+ "tags": [],
+ "label": "withEuiTablePersist",
+ "description": [],
+ "signature": [
+ "(WrappedComponent: React.ComponentClass, any>, euiTablePersistDefault: (",
+ "EuiTablePersistProps",
+ " & { get?: undefined; }) | { get: ",
+ {
+ "pluginId": "@kbn/shared-ux-table-persist",
+ "scope": "common",
+ "docId": "kibKbnSharedUxTablePersistPluginApi",
+ "section": "def-common.EuiTablePersistPropsGetter",
+ "text": "EuiTablePersistPropsGetter"
+ },
+ "; }) => React.FC<",
+ {
+ "pluginId": "@kbn/shared-ux-table-persist",
+ "scope": "common",
+ "docId": "kibKbnSharedUxTablePersistPluginApi",
+ "section": "def-common.HOCProps",
+ "text": "HOCProps"
+ },
+ ">>"
+ ],
+ "path": "packages/shared-ux/table_persist/src/table_persist_hoc.tsx",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.withEuiTablePersist.$1",
+ "type": "Object",
+ "tags": [],
+ "label": "WrappedComponent",
+ "description": [],
+ "signature": [
+ "React.ComponentClass, any>"
+ ],
+ "path": "packages/shared-ux/table_persist/src/table_persist_hoc.tsx",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ },
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.withEuiTablePersist.$2",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "euiTablePersistDefault",
+ "description": [],
+ "signature": [
+ "(",
+ "EuiTablePersistProps",
+ " & { get?: undefined; }) | { get: ",
+ {
+ "pluginId": "@kbn/shared-ux-table-persist",
+ "scope": "common",
+ "docId": "kibKbnSharedUxTablePersistPluginApi",
+ "section": "def-common.EuiTablePersistPropsGetter",
+ "text": "EuiTablePersistPropsGetter"
+ },
+ "; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/table_persist_hoc.tsx",
+ "deprecated": false,
+ "trackAdoption": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": [],
+ "initialIsOpen": false
+ }
+ ],
+ "interfaces": [
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.EuiTablePersistInjectedProps",
+ "type": "Interface",
+ "tags": [],
+ "label": "EuiTablePersistInjectedProps",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "@kbn/shared-ux-table-persist",
+ "scope": "common",
+ "docId": "kibKbnSharedUxTablePersistPluginApi",
+ "section": "def-common.EuiTablePersistInjectedProps",
+ "text": "EuiTablePersistInjectedProps"
+ },
+ ""
+ ],
+ "path": "packages/shared-ux/table_persist/src/table_persist_hoc.tsx",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.EuiTablePersistInjectedProps.euiTablePersist",
+ "type": "Object",
+ "tags": [],
+ "label": "euiTablePersist",
+ "description": [],
+ "signature": [
+ "{ onTableChange: (change: ",
+ "CriteriaWithPagination",
+ ") => void; sorting: true | { sort: ",
+ "PropertySort",
+ "; }; pageSize: number; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/table_persist_hoc.tsx",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
}
],
- "interfaces": [],
"enums": [],
"misc": [
{
@@ -79,6 +336,57 @@
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.EuiTablePersistPropsGetter",
+ "type": "Type",
+ "tags": [],
+ "label": "EuiTablePersistPropsGetter",
+ "description": [],
+ "signature": [
+ "(props: Omit) => ",
+ "EuiTablePersistProps",
+ ""
+ ],
+ "path": "packages/shared-ux/table_persist/src/table_persist_hoc.tsx",
+ "deprecated": false,
+ "trackAdoption": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.EuiTablePersistPropsGetter.$1",
+ "type": "Object",
+ "tags": [],
+ "label": "props",
+ "description": [],
+ "signature": [
+ "{ [P in Exclude]: P[P]; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/table_persist_hoc.tsx",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "@kbn/shared-ux-table-persist",
+ "id": "def-common.HOCProps",
+ "type": "Type",
+ "tags": [],
+ "label": "HOCProps",
+ "description": [],
+ "signature": [
+ "P & { euiTablePersistProps?: Partial<",
+ "EuiTablePersistProps",
+ "> | undefined; }"
+ ],
+ "path": "packages/shared-ux/table_persist/src/table_persist_hoc.tsx",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
}
],
"objects": []
diff --git a/api_docs/kbn_shared_ux_table_persist.mdx b/api_docs/kbn_shared_ux_table_persist.mdx
index fe81249f56292..06ed280a7243c 100644
--- a/api_docs/kbn_shared_ux_table_persist.mdx
+++ b/api_docs/kbn_shared_ux_table_persist.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-table-persist
title: "@kbn/shared-ux-table-persist"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-table-persist plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-table-persist']
---
import kbnSharedUxTablePersistObj from './kbn_shared_ux_table_persist.devdocs.json';
@@ -21,13 +21,16 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 3 | 0 | 2 | 2 |
+| 17 | 0 | 16 | 2 |
## Common
### Functions
+### Interfaces
+
+
### Consts, variables and types
diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx
index a9586856ced25..1cf9823de35f1 100644
--- a/api_docs/kbn_shared_ux_utility.mdx
+++ b/api_docs/kbn_shared_ux_utility.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility
title: "@kbn/shared-ux-utility"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/shared-ux-utility plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility']
---
import kbnSharedUxUtilityObj from './kbn_shared_ux_utility.devdocs.json';
diff --git a/api_docs/kbn_slo_schema.mdx b/api_docs/kbn_slo_schema.mdx
index 30fb28cefff1b..5849842e95def 100644
--- a/api_docs/kbn_slo_schema.mdx
+++ b/api_docs/kbn_slo_schema.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-slo-schema
title: "@kbn/slo-schema"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/slo-schema plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/slo-schema']
---
import kbnSloSchemaObj from './kbn_slo_schema.devdocs.json';
diff --git a/api_docs/kbn_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx
index d467f6eac980f..86c0a5b60bb34 100644
--- a/api_docs/kbn_some_dev_log.mdx
+++ b/api_docs/kbn_some_dev_log.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-some-dev-log
title: "@kbn/some-dev-log"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/some-dev-log plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/some-dev-log']
---
import kbnSomeDevLogObj from './kbn_some_dev_log.devdocs.json';
diff --git a/api_docs/kbn_sort_predicates.mdx b/api_docs/kbn_sort_predicates.mdx
index d4c40e523d65a..58808bafb8c26 100644
--- a/api_docs/kbn_sort_predicates.mdx
+++ b/api_docs/kbn_sort_predicates.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-sort-predicates
title: "@kbn/sort-predicates"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/sort-predicates plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-predicates']
---
import kbnSortPredicatesObj from './kbn_sort_predicates.devdocs.json';
diff --git a/api_docs/kbn_sse_utils.mdx b/api_docs/kbn_sse_utils.mdx
index 2c8d20e11e261..97f887d6916e9 100644
--- a/api_docs/kbn_sse_utils.mdx
+++ b/api_docs/kbn_sse_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-sse-utils
title: "@kbn/sse-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/sse-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sse-utils']
---
import kbnSseUtilsObj from './kbn_sse_utils.devdocs.json';
diff --git a/api_docs/kbn_sse_utils_client.mdx b/api_docs/kbn_sse_utils_client.mdx
index fc4625b516bf6..01be6b681684d 100644
--- a/api_docs/kbn_sse_utils_client.mdx
+++ b/api_docs/kbn_sse_utils_client.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-sse-utils-client
title: "@kbn/sse-utils-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/sse-utils-client plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sse-utils-client']
---
import kbnSseUtilsClientObj from './kbn_sse_utils_client.devdocs.json';
diff --git a/api_docs/kbn_sse_utils_server.mdx b/api_docs/kbn_sse_utils_server.mdx
index d9a1f0a8bf373..224cc31048ac4 100644
--- a/api_docs/kbn_sse_utils_server.mdx
+++ b/api_docs/kbn_sse_utils_server.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-sse-utils-server
title: "@kbn/sse-utils-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/sse-utils-server plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sse-utils-server']
---
import kbnSseUtilsServerObj from './kbn_sse_utils_server.devdocs.json';
diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx
index b3b71db876182..febd634486838 100644
--- a/api_docs/kbn_std.mdx
+++ b/api_docs/kbn_std.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-std
title: "@kbn/std"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/std plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std']
---
import kbnStdObj from './kbn_std.devdocs.json';
diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx
index 04cb212d04fc5..58880300d5bde 100644
--- a/api_docs/kbn_stdio_dev_helpers.mdx
+++ b/api_docs/kbn_stdio_dev_helpers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers
title: "@kbn/stdio-dev-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/stdio-dev-helpers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers']
---
import kbnStdioDevHelpersObj from './kbn_stdio_dev_helpers.devdocs.json';
diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx
index f82961fab9b0c..8ebca570d046e 100644
--- a/api_docs/kbn_storybook.mdx
+++ b/api_docs/kbn_storybook.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-storybook
title: "@kbn/storybook"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/storybook plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook']
---
import kbnStorybookObj from './kbn_storybook.devdocs.json';
diff --git a/api_docs/kbn_synthetics_e2e.mdx b/api_docs/kbn_synthetics_e2e.mdx
index cc329316b07cc..010d69a1b8aa7 100644
--- a/api_docs/kbn_synthetics_e2e.mdx
+++ b/api_docs/kbn_synthetics_e2e.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-synthetics-e2e
title: "@kbn/synthetics-e2e"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/synthetics-e2e plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/synthetics-e2e']
---
import kbnSyntheticsE2eObj from './kbn_synthetics_e2e.devdocs.json';
diff --git a/api_docs/kbn_synthetics_private_location.mdx b/api_docs/kbn_synthetics_private_location.mdx
index 6613f18809031..b7851081801d0 100644
--- a/api_docs/kbn_synthetics_private_location.mdx
+++ b/api_docs/kbn_synthetics_private_location.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-synthetics-private-location
title: "@kbn/synthetics-private-location"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/synthetics-private-location plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/synthetics-private-location']
---
import kbnSyntheticsPrivateLocationObj from './kbn_synthetics_private_location.devdocs.json';
diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx
index 466d473d2f61e..36b2444bb48a1 100644
--- a/api_docs/kbn_telemetry_tools.mdx
+++ b/api_docs/kbn_telemetry_tools.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools
title: "@kbn/telemetry-tools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/telemetry-tools plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools']
---
import kbnTelemetryToolsObj from './kbn_telemetry_tools.devdocs.json';
diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx
index 10f3ea72de6d8..40461c7c08ff8 100644
--- a/api_docs/kbn_test.mdx
+++ b/api_docs/kbn_test.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test
title: "@kbn/test"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/test plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test']
---
import kbnTestObj from './kbn_test.devdocs.json';
diff --git a/api_docs/kbn_test_eui_helpers.mdx b/api_docs/kbn_test_eui_helpers.mdx
index 13c9d14dba1c2..1a69ab75edb2e 100644
--- a/api_docs/kbn_test_eui_helpers.mdx
+++ b/api_docs/kbn_test_eui_helpers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-eui-helpers
title: "@kbn/test-eui-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/test-eui-helpers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-eui-helpers']
---
import kbnTestEuiHelpersObj from './kbn_test_eui_helpers.devdocs.json';
diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx
index f8f8832c2d212..6796757558f19 100644
--- a/api_docs/kbn_test_jest_helpers.mdx
+++ b/api_docs/kbn_test_jest_helpers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers
title: "@kbn/test-jest-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/test-jest-helpers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers']
---
import kbnTestJestHelpersObj from './kbn_test_jest_helpers.devdocs.json';
diff --git a/api_docs/kbn_test_subj_selector.mdx b/api_docs/kbn_test_subj_selector.mdx
index b395312055fff..1522caa831c31 100644
--- a/api_docs/kbn_test_subj_selector.mdx
+++ b/api_docs/kbn_test_subj_selector.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-subj-selector
title: "@kbn/test-subj-selector"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/test-subj-selector plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-subj-selector']
---
import kbnTestSubjSelectorObj from './kbn_test_subj_selector.devdocs.json';
diff --git a/api_docs/kbn_timerange.mdx b/api_docs/kbn_timerange.mdx
index f3b3b7d2bc9ce..ea5afd5d95344 100644
--- a/api_docs/kbn_timerange.mdx
+++ b/api_docs/kbn_timerange.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-timerange
title: "@kbn/timerange"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/timerange plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/timerange']
---
import kbnTimerangeObj from './kbn_timerange.devdocs.json';
diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx
index 8a615890131d6..beb39dd02b954 100644
--- a/api_docs/kbn_tooling_log.mdx
+++ b/api_docs/kbn_tooling_log.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log
title: "@kbn/tooling-log"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/tooling-log plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log']
---
import kbnToolingLogObj from './kbn_tooling_log.devdocs.json';
diff --git a/api_docs/kbn_transpose_utils.mdx b/api_docs/kbn_transpose_utils.mdx
index cbe205b0a3f57..f7c50e163efdd 100644
--- a/api_docs/kbn_transpose_utils.mdx
+++ b/api_docs/kbn_transpose_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-transpose-utils
title: "@kbn/transpose-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/transpose-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/transpose-utils']
---
import kbnTransposeUtilsObj from './kbn_transpose_utils.devdocs.json';
diff --git a/api_docs/kbn_triggers_actions_ui_types.mdx b/api_docs/kbn_triggers_actions_ui_types.mdx
index fe032e3b0f219..7f18eac98ec52 100644
--- a/api_docs/kbn_triggers_actions_ui_types.mdx
+++ b/api_docs/kbn_triggers_actions_ui_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-triggers-actions-ui-types
title: "@kbn/triggers-actions-ui-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/triggers-actions-ui-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/triggers-actions-ui-types']
---
import kbnTriggersActionsUiTypesObj from './kbn_triggers_actions_ui_types.devdocs.json';
diff --git a/api_docs/kbn_try_in_console.mdx b/api_docs/kbn_try_in_console.mdx
index 12fe1ab57c505..a6dd8c821d8ab 100644
--- a/api_docs/kbn_try_in_console.mdx
+++ b/api_docs/kbn_try_in_console.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-try-in-console
title: "@kbn/try-in-console"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/try-in-console plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/try-in-console']
---
import kbnTryInConsoleObj from './kbn_try_in_console.devdocs.json';
diff --git a/api_docs/kbn_ts_projects.mdx b/api_docs/kbn_ts_projects.mdx
index 4433a4091fc8e..ecfda351e476a 100644
--- a/api_docs/kbn_ts_projects.mdx
+++ b/api_docs/kbn_ts_projects.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ts-projects
title: "@kbn/ts-projects"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ts-projects plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ts-projects']
---
import kbnTsProjectsObj from './kbn_ts_projects.devdocs.json';
diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx
index 13b43dbc58fcf..87d01260b4357 100644
--- a/api_docs/kbn_typed_react_router_config.mdx
+++ b/api_docs/kbn_typed_react_router_config.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config
title: "@kbn/typed-react-router-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/typed-react-router-config plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config']
---
import kbnTypedReactRouterConfigObj from './kbn_typed_react_router_config.devdocs.json';
diff --git a/api_docs/kbn_ui_actions_browser.mdx b/api_docs/kbn_ui_actions_browser.mdx
index d6db62035fe51..6b26b2ad9952f 100644
--- a/api_docs/kbn_ui_actions_browser.mdx
+++ b/api_docs/kbn_ui_actions_browser.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-actions-browser
title: "@kbn/ui-actions-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ui-actions-browser plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-actions-browser']
---
import kbnUiActionsBrowserObj from './kbn_ui_actions_browser.devdocs.json';
diff --git a/api_docs/kbn_ui_shared_deps_src.devdocs.json b/api_docs/kbn_ui_shared_deps_src.devdocs.json
index ed0f25116b66d..2a61ae29701c1 100644
--- a/api_docs/kbn_ui_shared_deps_src.devdocs.json
+++ b/api_docs/kbn_ui_shared_deps_src.devdocs.json
@@ -699,6 +699,17 @@
"path": "packages/kbn-ui-shared-deps-src/src/definitions.js",
"deprecated": false,
"trackAdoption": false
+ },
+ {
+ "parentPluginId": "@kbn/ui-shared-deps-src",
+ "id": "def-common.externals.kbnreactkibanacontexttheme",
+ "type": "string",
+ "tags": [],
+ "label": "'@kbn/react-kibana-context-theme'",
+ "description": [],
+ "path": "packages/kbn-ui-shared-deps-src/src/definitions.js",
+ "deprecated": false,
+ "trackAdoption": false
}
],
"initialIsOpen": false
diff --git a/api_docs/kbn_ui_shared_deps_src.mdx b/api_docs/kbn_ui_shared_deps_src.mdx
index 3e41c36e846f4..c9249e50d8971 100644
--- a/api_docs/kbn_ui_shared_deps_src.mdx
+++ b/api_docs/kbn_ui_shared_deps_src.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-shared-deps-src
title: "@kbn/ui-shared-deps-src"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ui-shared-deps-src plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-shared-deps-src']
---
import kbnUiSharedDepsSrcObj from './kbn_ui_shared_deps_src.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kiban
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 59 | 0 | 50 | 0 |
+| 60 | 0 | 51 | 0 |
## Common
diff --git a/api_docs/kbn_ui_theme.devdocs.json b/api_docs/kbn_ui_theme.devdocs.json
index b7c9d0a6f2831..79750b38df53b 100644
--- a/api_docs/kbn_ui_theme.devdocs.json
+++ b/api_docs/kbn_ui_theme.devdocs.json
@@ -69,14 +69,6 @@
"deprecated": true,
"trackAdoption": false,
"references": [
- {
- "plugin": "@kbn/monaco",
- "path": "packages/kbn-monaco/src/esql/lib/esql_theme.ts"
- },
- {
- "plugin": "@kbn/monaco",
- "path": "packages/kbn-monaco/src/esql/lib/esql_theme.ts"
- },
{
"plugin": "@kbn/monaco",
"path": "packages/kbn-monaco/src/console/theme.ts"
diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx
index 479adfd58730d..c9a665af3aacf 100644
--- a/api_docs/kbn_ui_theme.mdx
+++ b/api_docs/kbn_ui_theme.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme
title: "@kbn/ui-theme"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ui-theme plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme']
---
import kbnUiThemeObj from './kbn_ui_theme.devdocs.json';
diff --git a/api_docs/kbn_unified_data_table.devdocs.json b/api_docs/kbn_unified_data_table.devdocs.json
index 3c035dc025739..1398b8b7116ac 100644
--- a/api_docs/kbn_unified_data_table.devdocs.json
+++ b/api_docs/kbn_unified_data_table.devdocs.json
@@ -2056,9 +2056,9 @@
"{ theme: ",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
},
"; fieldFormats: ",
diff --git a/api_docs/kbn_unified_data_table.mdx b/api_docs/kbn_unified_data_table.mdx
index 4cde671510f9c..6e92450416f2c 100644
--- a/api_docs/kbn_unified_data_table.mdx
+++ b/api_docs/kbn_unified_data_table.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unified-data-table
title: "@kbn/unified-data-table"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/unified-data-table plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unified-data-table']
---
import kbnUnifiedDataTableObj from './kbn_unified_data_table.devdocs.json';
diff --git a/api_docs/kbn_unified_doc_viewer.mdx b/api_docs/kbn_unified_doc_viewer.mdx
index e064e33f09db1..e73502404b937 100644
--- a/api_docs/kbn_unified_doc_viewer.mdx
+++ b/api_docs/kbn_unified_doc_viewer.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unified-doc-viewer
title: "@kbn/unified-doc-viewer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/unified-doc-viewer plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unified-doc-viewer']
---
import kbnUnifiedDocViewerObj from './kbn_unified_doc_viewer.devdocs.json';
diff --git a/api_docs/kbn_unified_field_list.mdx b/api_docs/kbn_unified_field_list.mdx
index 8f75958aae541..679c8a1a627bf 100644
--- a/api_docs/kbn_unified_field_list.mdx
+++ b/api_docs/kbn_unified_field_list.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unified-field-list
title: "@kbn/unified-field-list"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/unified-field-list plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unified-field-list']
---
import kbnUnifiedFieldListObj from './kbn_unified_field_list.devdocs.json';
diff --git a/api_docs/kbn_unsaved_changes_badge.mdx b/api_docs/kbn_unsaved_changes_badge.mdx
index 0a1fd22d24923..69b103c013ea3 100644
--- a/api_docs/kbn_unsaved_changes_badge.mdx
+++ b/api_docs/kbn_unsaved_changes_badge.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unsaved-changes-badge
title: "@kbn/unsaved-changes-badge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/unsaved-changes-badge plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unsaved-changes-badge']
---
import kbnUnsavedChangesBadgeObj from './kbn_unsaved_changes_badge.devdocs.json';
diff --git a/api_docs/kbn_unsaved_changes_prompt.mdx b/api_docs/kbn_unsaved_changes_prompt.mdx
index e8f6b60b9b17a..743ab3d4ff54a 100644
--- a/api_docs/kbn_unsaved_changes_prompt.mdx
+++ b/api_docs/kbn_unsaved_changes_prompt.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unsaved-changes-prompt
title: "@kbn/unsaved-changes-prompt"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/unsaved-changes-prompt plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unsaved-changes-prompt']
---
import kbnUnsavedChangesPromptObj from './kbn_unsaved_changes_prompt.devdocs.json';
diff --git a/api_docs/kbn_use_tracked_promise.mdx b/api_docs/kbn_use_tracked_promise.mdx
index 208f1b07df0f8..08e527d88a14c 100644
--- a/api_docs/kbn_use_tracked_promise.mdx
+++ b/api_docs/kbn_use_tracked_promise.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-use-tracked-promise
title: "@kbn/use-tracked-promise"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/use-tracked-promise plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/use-tracked-promise']
---
import kbnUseTrackedPromiseObj from './kbn_use_tracked_promise.devdocs.json';
diff --git a/api_docs/kbn_user_profile_components.devdocs.json b/api_docs/kbn_user_profile_components.devdocs.json
index c5a703d4e9cc2..34214d8791833 100644
--- a/api_docs/kbn_user_profile_components.devdocs.json
+++ b/api_docs/kbn_user_profile_components.devdocs.json
@@ -976,9 +976,9 @@
", \"reportEvent\"> | undefined; theme: ",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
},
"; }"
diff --git a/api_docs/kbn_user_profile_components.mdx b/api_docs/kbn_user_profile_components.mdx
index 3ae785228bd7c..c60ec0e607d48 100644
--- a/api_docs/kbn_user_profile_components.mdx
+++ b/api_docs/kbn_user_profile_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-user-profile-components
title: "@kbn/user-profile-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/user-profile-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/user-profile-components']
---
import kbnUserProfileComponentsObj from './kbn_user_profile_components.devdocs.json';
diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx
index f4b41f84a99f7..ae809e17f6738 100644
--- a/api_docs/kbn_utility_types.mdx
+++ b/api_docs/kbn_utility_types.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types
title: "@kbn/utility-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/utility-types plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types']
---
import kbnUtilityTypesObj from './kbn_utility_types.devdocs.json';
diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx
index 4106521cda3b4..fd12297b5b8c9 100644
--- a/api_docs/kbn_utility_types_jest.mdx
+++ b/api_docs/kbn_utility_types_jest.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest
title: "@kbn/utility-types-jest"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/utility-types-jest plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest']
---
import kbnUtilityTypesJestObj from './kbn_utility_types_jest.devdocs.json';
diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx
index d50ba5b97d308..3d49b2cf72612 100644
--- a/api_docs/kbn_utils.mdx
+++ b/api_docs/kbn_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utils
title: "@kbn/utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils']
---
import kbnUtilsObj from './kbn_utils.devdocs.json';
diff --git a/api_docs/kbn_visualization_ui_components.mdx b/api_docs/kbn_visualization_ui_components.mdx
index 891f156a20b89..0710e42dc8eba 100644
--- a/api_docs/kbn_visualization_ui_components.mdx
+++ b/api_docs/kbn_visualization_ui_components.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-visualization-ui-components
title: "@kbn/visualization-ui-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/visualization-ui-components plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/visualization-ui-components']
---
import kbnVisualizationUiComponentsObj from './kbn_visualization_ui_components.devdocs.json';
diff --git a/api_docs/kbn_visualization_utils.mdx b/api_docs/kbn_visualization_utils.mdx
index 2b94ad489079d..5f8fa23f162c4 100644
--- a/api_docs/kbn_visualization_utils.mdx
+++ b/api_docs/kbn_visualization_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-visualization-utils
title: "@kbn/visualization-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/visualization-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/visualization-utils']
---
import kbnVisualizationUtilsObj from './kbn_visualization_utils.devdocs.json';
diff --git a/api_docs/kbn_xstate_utils.mdx b/api_docs/kbn_xstate_utils.mdx
index 110c6928e2dc1..1aaae7295b988 100644
--- a/api_docs/kbn_xstate_utils.mdx
+++ b/api_docs/kbn_xstate_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-xstate-utils
title: "@kbn/xstate-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/xstate-utils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/xstate-utils']
---
import kbnXstateUtilsObj from './kbn_xstate_utils.devdocs.json';
diff --git a/api_docs/kbn_yarn_lock_validator.mdx b/api_docs/kbn_yarn_lock_validator.mdx
index aa9c0c8364ca6..6aa5f611d5ce0 100644
--- a/api_docs/kbn_yarn_lock_validator.mdx
+++ b/api_docs/kbn_yarn_lock_validator.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-yarn-lock-validator
title: "@kbn/yarn-lock-validator"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/yarn-lock-validator plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/yarn-lock-validator']
---
import kbnYarnLockValidatorObj from './kbn_yarn_lock_validator.devdocs.json';
diff --git a/api_docs/kbn_zod.mdx b/api_docs/kbn_zod.mdx
index 18bcb260fbade..a53a340bc5e8e 100644
--- a/api_docs/kbn_zod.mdx
+++ b/api_docs/kbn_zod.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-zod
title: "@kbn/zod"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/zod plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/zod']
---
import kbnZodObj from './kbn_zod.devdocs.json';
diff --git a/api_docs/kbn_zod_helpers.mdx b/api_docs/kbn_zod_helpers.mdx
index 18283b301392b..5c179412886ef 100644
--- a/api_docs/kbn_zod_helpers.mdx
+++ b/api_docs/kbn_zod_helpers.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-zod-helpers
title: "@kbn/zod-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/zod-helpers plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/zod-helpers']
---
import kbnZodHelpersObj from './kbn_zod_helpers.devdocs.json';
diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx
index ef9e441f040af..fefc3fbc8e142 100644
--- a/api_docs/kibana_overview.mdx
+++ b/api_docs/kibana_overview.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaOverview
title: "kibanaOverview"
image: https://source.unsplash.com/400x175/?github
description: API docs for the kibanaOverview plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview']
---
import kibanaOverviewObj from './kibana_overview.devdocs.json';
diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json
index faca5278b8eba..99e4d8fe29755 100644
--- a/api_docs/kibana_react.devdocs.json
+++ b/api_docs/kibana_react.devdocs.json
@@ -1455,9 +1455,9 @@
"<",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.KibanaTheme",
+ "section": "def-common.KibanaTheme",
"text": "KibanaTheme"
},
">) => React.JSX.Element"
@@ -1493,9 +1493,9 @@
"<",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.KibanaTheme",
+ "section": "def-common.KibanaTheme",
"text": "KibanaTheme"
},
">"
@@ -2653,17 +2653,17 @@
"Pick<",
{
"pluginId": "@kbn/react-kibana-context-theme",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextThemePluginApi",
- "section": "def-public.KibanaThemeProviderProps",
+ "section": "def-common.KibanaThemeProviderProps",
"text": "KibanaThemeProviderProps"
},
", \"children\" | \"modify\"> & ",
{
"pluginId": "@kbn/react-kibana-context-common",
- "scope": "public",
+ "scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
- "section": "def-public.ThemeServiceStart",
+ "section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
}
],
diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx
index f92ab481f5832..bf766ea8f113f 100644
--- a/api_docs/kibana_react.mdx
+++ b/api_docs/kibana_react.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaReact
title: "kibanaReact"
image: https://source.unsplash.com/400x175/?github
description: API docs for the kibanaReact plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact']
---
import kibanaReactObj from './kibana_react.devdocs.json';
diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx
index 8d2906bdad766..f2caa5e23d7b3 100644
--- a/api_docs/kibana_utils.mdx
+++ b/api_docs/kibana_utils.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaUtils
title: "kibanaUtils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the kibanaUtils plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils']
---
import kibanaUtilsObj from './kibana_utils.devdocs.json';
diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx
index 1e6f1c5493b32..a9db4da2dc551 100644
--- a/api_docs/kubernetes_security.mdx
+++ b/api_docs/kubernetes_security.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity
title: "kubernetesSecurity"
image: https://source.unsplash.com/400x175/?github
description: API docs for the kubernetesSecurity plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity']
---
import kubernetesSecurityObj from './kubernetes_security.devdocs.json';
diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx
index daf3d3a99b2c8..373bbe2f38835 100644
--- a/api_docs/lens.mdx
+++ b/api_docs/lens.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lens
title: "lens"
image: https://source.unsplash.com/400x175/?github
description: API docs for the lens plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens']
---
import lensObj from './lens.devdocs.json';
diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx
index 2ce635523e7d8..384de74cedc5c 100644
--- a/api_docs/license_api_guard.mdx
+++ b/api_docs/license_api_guard.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard
title: "licenseApiGuard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the licenseApiGuard plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard']
---
import licenseApiGuardObj from './license_api_guard.devdocs.json';
diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx
index 3fc3a084f9a19..d7749a9229353 100644
--- a/api_docs/license_management.mdx
+++ b/api_docs/license_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseManagement
title: "licenseManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the licenseManagement plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement']
---
import licenseManagementObj from './license_management.devdocs.json';
diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx
index 348566bafd9a5..5344bf70f5584 100644
--- a/api_docs/licensing.mdx
+++ b/api_docs/licensing.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licensing
title: "licensing"
image: https://source.unsplash.com/400x175/?github
description: API docs for the licensing plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing']
---
import licensingObj from './licensing.devdocs.json';
diff --git a/api_docs/links.mdx b/api_docs/links.mdx
index eca0c6488071a..311c805a8d2ed 100644
--- a/api_docs/links.mdx
+++ b/api_docs/links.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/links
title: "links"
image: https://source.unsplash.com/400x175/?github
description: API docs for the links plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'links']
---
import linksObj from './links.devdocs.json';
diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx
index d45f50bda56f1..08c95634e190a 100644
--- a/api_docs/lists.mdx
+++ b/api_docs/lists.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lists
title: "lists"
image: https://source.unsplash.com/400x175/?github
description: API docs for the lists plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists']
---
import listsObj from './lists.devdocs.json';
diff --git a/api_docs/logs_data_access.mdx b/api_docs/logs_data_access.mdx
index ccc6c62edb9b2..78b3a7e9b4bc5 100644
--- a/api_docs/logs_data_access.mdx
+++ b/api_docs/logs_data_access.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/logsDataAccess
title: "logsDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the logsDataAccess plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsDataAccess']
---
import logsDataAccessObj from './logs_data_access.devdocs.json';
diff --git a/api_docs/logs_explorer.mdx b/api_docs/logs_explorer.mdx
index a3b383da8102c..af8344bcb022e 100644
--- a/api_docs/logs_explorer.mdx
+++ b/api_docs/logs_explorer.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/logsExplorer
title: "logsExplorer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the logsExplorer plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsExplorer']
---
import logsExplorerObj from './logs_explorer.devdocs.json';
diff --git a/api_docs/logs_shared.mdx b/api_docs/logs_shared.mdx
index d49f5c8302c05..7894519385f1e 100644
--- a/api_docs/logs_shared.mdx
+++ b/api_docs/logs_shared.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/logsShared
title: "logsShared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the logsShared plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsShared']
---
import logsSharedObj from './logs_shared.devdocs.json';
diff --git a/api_docs/management.mdx b/api_docs/management.mdx
index 6d3d02c3ab6e2..158469eae5cd5 100644
--- a/api_docs/management.mdx
+++ b/api_docs/management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/management
title: "management"
image: https://source.unsplash.com/400x175/?github
description: API docs for the management plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management']
---
import managementObj from './management.devdocs.json';
diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx
index ebc67a2f07f4d..8a2518435d53d 100644
--- a/api_docs/maps.mdx
+++ b/api_docs/maps.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/maps
title: "maps"
image: https://source.unsplash.com/400x175/?github
description: API docs for the maps plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps']
---
import mapsObj from './maps.devdocs.json';
diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx
index 94c6ff11f1496..fde7bdc426948 100644
--- a/api_docs/maps_ems.mdx
+++ b/api_docs/maps_ems.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/mapsEms
title: "mapsEms"
image: https://source.unsplash.com/400x175/?github
description: API docs for the mapsEms plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms']
---
import mapsEmsObj from './maps_ems.devdocs.json';
diff --git a/api_docs/metrics_data_access.mdx b/api_docs/metrics_data_access.mdx
index f7add12b3100c..5a252eaae4b4d 100644
--- a/api_docs/metrics_data_access.mdx
+++ b/api_docs/metrics_data_access.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/metricsDataAccess
title: "metricsDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the metricsDataAccess plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'metricsDataAccess']
---
import metricsDataAccessObj from './metrics_data_access.devdocs.json';
diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx
index 63c1f411b4844..ea44e1ec9a966 100644
--- a/api_docs/ml.mdx
+++ b/api_docs/ml.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ml
title: "ml"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ml plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml']
---
import mlObj from './ml.devdocs.json';
diff --git a/api_docs/mock_idp_plugin.mdx b/api_docs/mock_idp_plugin.mdx
index 3cb21e68124c8..f944972b77892 100644
--- a/api_docs/mock_idp_plugin.mdx
+++ b/api_docs/mock_idp_plugin.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/mockIdpPlugin
title: "mockIdpPlugin"
image: https://source.unsplash.com/400x175/?github
description: API docs for the mockIdpPlugin plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mockIdpPlugin']
---
import mockIdpPluginObj from './mock_idp_plugin.devdocs.json';
diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx
index 710bf8e4a2059..7ae60fd1f5356 100644
--- a/api_docs/monitoring.mdx
+++ b/api_docs/monitoring.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoring
title: "monitoring"
image: https://source.unsplash.com/400x175/?github
description: API docs for the monitoring plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring']
---
import monitoringObj from './monitoring.devdocs.json';
diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx
index 7aed1205cb353..5b62e6e0d1283 100644
--- a/api_docs/monitoring_collection.mdx
+++ b/api_docs/monitoring_collection.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoringCollection
title: "monitoringCollection"
image: https://source.unsplash.com/400x175/?github
description: API docs for the monitoringCollection plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection']
---
import monitoringCollectionObj from './monitoring_collection.devdocs.json';
diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx
index 168557c64a1af..496072f43a492 100644
--- a/api_docs/navigation.mdx
+++ b/api_docs/navigation.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/navigation
title: "navigation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the navigation plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation']
---
import navigationObj from './navigation.devdocs.json';
diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx
index b712e4d801de8..c7f9280661b62 100644
--- a/api_docs/newsfeed.mdx
+++ b/api_docs/newsfeed.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/newsfeed
title: "newsfeed"
image: https://source.unsplash.com/400x175/?github
description: API docs for the newsfeed plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed']
---
import newsfeedObj from './newsfeed.devdocs.json';
diff --git a/api_docs/no_data_page.mdx b/api_docs/no_data_page.mdx
index 42930cdb35f89..119862d079f69 100644
--- a/api_docs/no_data_page.mdx
+++ b/api_docs/no_data_page.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/noDataPage
title: "noDataPage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the noDataPage plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'noDataPage']
---
import noDataPageObj from './no_data_page.devdocs.json';
diff --git a/api_docs/notifications.mdx b/api_docs/notifications.mdx
index 3b6745819d7e9..605975c60b42b 100644
--- a/api_docs/notifications.mdx
+++ b/api_docs/notifications.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/notifications
title: "notifications"
image: https://source.unsplash.com/400x175/?github
description: API docs for the notifications plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'notifications']
---
import notificationsObj from './notifications.devdocs.json';
diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx
index 8c4947c86f68f..f728ea4fa7e9b 100644
--- a/api_docs/observability.mdx
+++ b/api_docs/observability.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observability
title: "observability"
image: https://source.unsplash.com/400x175/?github
description: API docs for the observability plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability']
---
import observabilityObj from './observability.devdocs.json';
diff --git a/api_docs/observability_a_i_assistant.devdocs.json b/api_docs/observability_a_i_assistant.devdocs.json
index 938513b0d6f57..913dfebf5bf4f 100644
--- a/api_docs/observability_a_i_assistant.devdocs.json
+++ b/api_docs/observability_a_i_assistant.devdocs.json
@@ -2187,7 +2187,7 @@
"label": "callApi",
"description": [],
"signature": [
- "(endpoint: TEndpoint, ...args: MaybeOptionalArgs<",
+ "(endpoint: TEndpoint, ...args: MaybeOptionalArgs<",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
@@ -2479,11 +2479,25 @@
},
"<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", { enabled: boolean; ready: boolean; error?: any; deployment_state?: ",
+ ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<",
+ "InferenceInferenceEndpointInfo",
+ "> | undefined; model_stats?: { deployment_state: ",
"MlDeploymentState",
- " | undefined; allocation_state?: ",
+ " | undefined; allocation_state: ",
"MlDeploymentAllocationState",
- " | undefined; model_name?: string | undefined; }, ",
+ " | undefined; } | undefined; }, ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/reset\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", { result: string; }, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/kb/setup\": ",
{
@@ -2493,9 +2507,29 @@
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
- "<\"POST /internal/observability_ai_assistant/kb/setup\", undefined, ",
+ "<\"POST /internal/observability_ai_assistant/kb/setup\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ model_id: ",
+ "StringC",
+ "; }>; }>, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", {}, ",
+ ", ",
+ "InferenceInferenceEndpointInfo",
+ ", ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/semantic_text_migration\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/semantic_text_migration\", undefined, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", void, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/functions/summarize\": ",
{
@@ -3417,11 +3451,25 @@
},
"<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", { enabled: boolean; ready: boolean; error?: any; deployment_state?: ",
+ ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<",
+ "InferenceInferenceEndpointInfo",
+ "> | undefined; model_stats?: { deployment_state: ",
"MlDeploymentState",
- " | undefined; allocation_state?: ",
+ " | undefined; allocation_state: ",
"MlDeploymentAllocationState",
- " | undefined; model_name?: string | undefined; }, ",
+ " | undefined; } | undefined; }, ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/reset\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", { result: string; }, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/kb/setup\": ",
{
@@ -3431,9 +3479,29 @@
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
- "<\"POST /internal/observability_ai_assistant/kb/setup\", undefined, ",
+ "<\"POST /internal/observability_ai_assistant/kb/setup\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ model_id: ",
+ "StringC",
+ "; }>; }>, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", ",
+ "InferenceInferenceEndpointInfo",
+ ", ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/semantic_text_migration\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/semantic_text_migration\", undefined, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", {}, ",
+ ", void, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/functions/summarize\": ",
{
@@ -5076,11 +5144,25 @@
},
"<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", { enabled: boolean; ready: boolean; error?: any; deployment_state?: ",
+ ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<",
+ "InferenceInferenceEndpointInfo",
+ "> | undefined; model_stats?: { deployment_state: ",
"MlDeploymentState",
- " | undefined; allocation_state?: ",
+ " | undefined; allocation_state: ",
"MlDeploymentAllocationState",
- " | undefined; model_name?: string | undefined; }, ",
+ " | undefined; } | undefined; }, ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/reset\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", { result: string; }, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/kb/setup\": ",
{
@@ -5090,9 +5172,29 @@
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
- "<\"POST /internal/observability_ai_assistant/kb/setup\", undefined, ",
+ "<\"POST /internal/observability_ai_assistant/kb/setup\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ model_id: ",
+ "StringC",
+ "; }>; }>, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", ",
+ "InferenceInferenceEndpointInfo",
+ ", ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/semantic_text_migration\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/semantic_text_migration\", undefined, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", {}, ",
+ ", void, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/functions/summarize\": ",
{
@@ -6257,11 +6359,25 @@
},
"<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", { enabled: boolean; ready: boolean; error?: any; deployment_state?: ",
+ ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<",
+ "InferenceInferenceEndpointInfo",
+ "> | undefined; model_stats?: { deployment_state: ",
"MlDeploymentState",
- " | undefined; allocation_state?: ",
+ " | undefined; allocation_state: ",
"MlDeploymentAllocationState",
- " | undefined; model_name?: string | undefined; }, ",
+ " | undefined; } | undefined; }, ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/reset\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", { result: string; }, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/kb/setup\": ",
{
@@ -6271,9 +6387,29 @@
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
- "<\"POST /internal/observability_ai_assistant/kb/setup\", undefined, ",
+ "<\"POST /internal/observability_ai_assistant/kb/setup\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ model_id: ",
+ "StringC",
+ "; }>; }>, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", {}, ",
+ ", ",
+ "InferenceInferenceEndpointInfo",
+ ", ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/semantic_text_migration\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/semantic_text_migration\", undefined, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", void, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/functions/summarize\": ",
{
@@ -6950,7 +7086,7 @@
"label": "ObservabilityAIAssistantAPIEndpoint",
"description": [],
"signature": [
- "\"POST /internal/observability_ai_assistant/chat\" | \"POST /internal/observability_ai_assistant/chat/recall\" | \"POST /internal/observability_ai_assistant/chat/complete\" | \"POST /api/observability_ai_assistant/chat/complete 2023-10-31\" | \"GET /internal/observability_ai_assistant/conversation/{conversationId}\" | \"POST /internal/observability_ai_assistant/conversations\" | \"POST /internal/observability_ai_assistant/conversation\" | \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\" | \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\" | \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\" | \"GET /internal/observability_ai_assistant/connectors\" | \"GET /internal/observability_ai_assistant/functions\" | \"POST /internal/observability_ai_assistant/functions/recall\" | \"POST /internal/observability_ai_assistant/functions/summarize\" | \"POST /internal/observability_ai_assistant/kb/setup\" | \"GET /internal/observability_ai_assistant/kb/status\" | \"GET /internal/observability_ai_assistant/kb/entries\" | \"PUT /internal/observability_ai_assistant/kb/user_instructions\" | \"POST /internal/observability_ai_assistant/kb/entries/import\" | \"GET /internal/observability_ai_assistant/kb/user_instructions\" | \"POST /internal/observability_ai_assistant/kb/entries/save\" | \"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\""
+ "\"POST /internal/observability_ai_assistant/chat\" | \"POST /internal/observability_ai_assistant/chat/recall\" | \"POST /internal/observability_ai_assistant/chat/complete\" | \"POST /api/observability_ai_assistant/chat/complete 2023-10-31\" | \"GET /internal/observability_ai_assistant/conversation/{conversationId}\" | \"POST /internal/observability_ai_assistant/conversations\" | \"POST /internal/observability_ai_assistant/conversation\" | \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\" | \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\" | \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\" | \"GET /internal/observability_ai_assistant/connectors\" | \"GET /internal/observability_ai_assistant/functions\" | \"POST /internal/observability_ai_assistant/functions/recall\" | \"POST /internal/observability_ai_assistant/functions/summarize\" | \"POST /internal/observability_ai_assistant/kb/semantic_text_migration\" | \"POST /internal/observability_ai_assistant/kb/setup\" | \"POST /internal/observability_ai_assistant/kb/reset\" | \"GET /internal/observability_ai_assistant/kb/status\" | \"GET /internal/observability_ai_assistant/kb/entries\" | \"PUT /internal/observability_ai_assistant/kb/user_instructions\" | \"POST /internal/observability_ai_assistant/kb/entries/import\" | \"GET /internal/observability_ai_assistant/kb/user_instructions\" | \"POST /internal/observability_ai_assistant/kb/entries/save\" | \"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\""
],
"path": "x-pack/plugins/observability_solution/observability_ai_assistant/public/api/index.ts",
"deprecated": false,
@@ -7963,11 +8099,25 @@
},
"<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", { enabled: boolean; ready: boolean; error?: any; deployment_state?: ",
+ ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<",
+ "InferenceInferenceEndpointInfo",
+ "> | undefined; model_stats?: { deployment_state: ",
"MlDeploymentState",
- " | undefined; allocation_state?: ",
+ " | undefined; allocation_state: ",
"MlDeploymentAllocationState",
- " | undefined; model_name?: string | undefined; }, ",
+ " | undefined; } | undefined; }, ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/reset\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", { result: string; }, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/kb/setup\": ",
{
@@ -7977,9 +8127,29 @@
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
- "<\"POST /internal/observability_ai_assistant/kb/setup\", undefined, ",
+ "<\"POST /internal/observability_ai_assistant/kb/setup\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ model_id: ",
+ "StringC",
+ "; }>; }>, ",
+ "ObservabilityAIAssistantRouteHandlerResources",
+ ", ",
+ "InferenceInferenceEndpointInfo",
+ ", ",
+ "ObservabilityAIAssistantRouteCreateOptions",
+ ">; \"POST /internal/observability_ai_assistant/kb/semantic_text_migration\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /internal/observability_ai_assistant/kb/semantic_text_migration\", undefined, ",
"ObservabilityAIAssistantRouteHandlerResources",
- ", {}, ",
+ ", void, ",
"ObservabilityAIAssistantRouteCreateOptions",
">; \"POST /internal/observability_ai_assistant/functions/summarize\": ",
{
diff --git a/api_docs/observability_a_i_assistant.mdx b/api_docs/observability_a_i_assistant.mdx
index a38da27f1e331..d9cce36dffe60 100644
--- a/api_docs/observability_a_i_assistant.mdx
+++ b/api_docs/observability_a_i_assistant.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityAIAssistant
title: "observabilityAIAssistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the observabilityAIAssistant plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityAIAssistant']
---
import observabilityAIAssistantObj from './observability_a_i_assistant.devdocs.json';
diff --git a/api_docs/observability_a_i_assistant_app.mdx b/api_docs/observability_a_i_assistant_app.mdx
index 0e4f44635fc1f..3536df0a49b49 100644
--- a/api_docs/observability_a_i_assistant_app.mdx
+++ b/api_docs/observability_a_i_assistant_app.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityAIAssistantApp
title: "observabilityAIAssistantApp"
image: https://source.unsplash.com/400x175/?github
description: API docs for the observabilityAIAssistantApp plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityAIAssistantApp']
---
import observabilityAIAssistantAppObj from './observability_a_i_assistant_app.devdocs.json';
diff --git a/api_docs/observability_ai_assistant_management.mdx b/api_docs/observability_ai_assistant_management.mdx
index 57f9506503ef8..d4567385c8703 100644
--- a/api_docs/observability_ai_assistant_management.mdx
+++ b/api_docs/observability_ai_assistant_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityAiAssistantManagement
title: "observabilityAiAssistantManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the observabilityAiAssistantManagement plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityAiAssistantManagement']
---
import observabilityAiAssistantManagementObj from './observability_ai_assistant_management.devdocs.json';
diff --git a/api_docs/observability_logs_explorer.mdx b/api_docs/observability_logs_explorer.mdx
index 36a29bd164573..4afb5190018cf 100644
--- a/api_docs/observability_logs_explorer.mdx
+++ b/api_docs/observability_logs_explorer.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityLogsExplorer
title: "observabilityLogsExplorer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the observabilityLogsExplorer plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityLogsExplorer']
---
import observabilityLogsExplorerObj from './observability_logs_explorer.devdocs.json';
diff --git a/api_docs/observability_onboarding.mdx b/api_docs/observability_onboarding.mdx
index 011cae81e11e5..306031fa78045 100644
--- a/api_docs/observability_onboarding.mdx
+++ b/api_docs/observability_onboarding.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityOnboarding
title: "observabilityOnboarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the observabilityOnboarding plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityOnboarding']
---
import observabilityOnboardingObj from './observability_onboarding.devdocs.json';
diff --git a/api_docs/observability_shared.mdx b/api_docs/observability_shared.mdx
index a7f225b021e24..8dd043f350144 100644
--- a/api_docs/observability_shared.mdx
+++ b/api_docs/observability_shared.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityShared
title: "observabilityShared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the observabilityShared plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityShared']
---
import observabilitySharedObj from './observability_shared.devdocs.json';
diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx
index ea83005ea7376..46cd632977208 100644
--- a/api_docs/osquery.mdx
+++ b/api_docs/osquery.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/osquery
title: "osquery"
image: https://source.unsplash.com/400x175/?github
description: API docs for the osquery plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery']
---
import osqueryObj from './osquery.devdocs.json';
diff --git a/api_docs/painless_lab.mdx b/api_docs/painless_lab.mdx
index 72a978d3ac69a..f4bccf19eb2aa 100644
--- a/api_docs/painless_lab.mdx
+++ b/api_docs/painless_lab.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/painlessLab
title: "painlessLab"
image: https://source.unsplash.com/400x175/?github
description: API docs for the painlessLab plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'painlessLab']
---
import painlessLabObj from './painless_lab.devdocs.json';
diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx
index 45c331b12c5be..b250a83cfafaa 100644
--- a/api_docs/plugin_directory.mdx
+++ b/api_docs/plugin_directory.mdx
@@ -7,7 +7,7 @@ id: kibDevDocsPluginDirectory
slug: /kibana-dev-docs/api-meta/plugin-api-directory
title: Directory
description: Directory of public APIs available through plugins or packages.
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@@ -15,13 +15,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Count | Plugins or Packages with a public API | Number of teams |
|--------------|----------|------------------------|
-| 880 | 752 | 46 |
+| 884 | 754 | 47 |
### Public API health stats
| API Count | Any Count | Missing comments | Missing exports |
|--------------|----------|-----------------|--------|
-| 54298 | 240 | 40768 | 2005 |
+| 54380 | 247 | 40840 | 2011 |
## Plugin Directory
@@ -48,7 +48,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| cloudLinks | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Adds the links to the Elastic Cloud console | 0 | 0 | 0 | 0 |
| | [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic/teams/kibana-cloud-security-posture) | The cloud security posture plugin | 13 | 0 | 2 | 2 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 39 | 0 | 30 | 0 |
-| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Content management app | 149 | 0 | 125 | 6 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Content management app | 150 | 0 | 126 | 6 |
| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 135 | 0 | 131 | 15 |
| crossClusterReplication | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 0 | 0 | 0 | 0 |
| customBranding | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Enables customization of Kibana | 0 | 0 | 0 | 0 |
@@ -67,7 +67,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 15 | 0 | 9 | 2 |
| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 148 | 0 | 100 | 24 |
| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 35 | 0 | 33 | 2 |
-| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | A stateful layer to register shared features and provide an access point to discover without a direct dependency | 16 | 0 | 15 | 2 |
+| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | A stateful layer to register shared features and provide an access point to discover without a direct dependency | 16 | 0 | 15 | 3 |
| | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | APIs used to assess the quality of data in Elasticsearch indexes | 2 | 0 | 0 | 0 |
| | [@elastic/security-generative-ai](https://github.com/orgs/elastic/teams/security-generative-ai) | Server APIs for the Elastic AI Assistant | 53 | 0 | 38 | 2 |
| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds embeddables service to Kibana | 578 | 1 | 468 | 9 |
@@ -103,7 +103,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 89 | 0 | 89 | 8 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | File upload, download, sharing, and serving over HTTP implementation in Kibana. | 240 | 0 | 24 | 9 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Simple UI for managing files in Kibana | 3 | 0 | 3 | 0 |
-| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1418 | 5 | 1295 | 81 |
+| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1427 | 5 | 1302 | 81 |
| ftrApis | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 72 | 0 | 14 | 5 |
| globalSearchBar | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 0 | 0 | 0 | 0 |
@@ -114,7 +114,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 149 | 0 | 111 | 1 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Image embeddable | 1 | 0 | 1 | 0 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 4 | 0 | 4 | 0 |
-| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 241 | 0 | 236 | 1 |
+| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 244 | 0 | 239 | 1 |
| | [@elastic/appex-ai-infra](https://github.com/orgs/elastic/teams/appex-ai-infra) | - | 33 | 0 | 28 | 4 |
| | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 24 | 0 | 24 | 5 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 4 | 0 | 4 | 0 |
@@ -162,7 +162,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/security-defend-workflows](https://github.com/orgs/elastic/teams/security-defend-workflows) | - | 23 | 0 | 23 | 7 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 2 | 0 | 2 | 0 |
| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds a standardized Presentation panel which allows any forward ref component to interface with various Kibana systems. | 11 | 0 | 11 | 4 |
-| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 160 | 2 | 130 | 10 |
+| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 159 | 2 | 129 | 10 |
| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 16 | 1 | 16 | 0 |
| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 22 | 0 | 22 | 7 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 23 | 0 | 23 | 0 |
@@ -171,7 +171,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 263 | 0 | 226 | 10 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 24 | 0 | 19 | 2 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 114 | 2 | 109 | 5 |
-| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 25 | 0 | 25 | 0 |
+| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 25 | 0 | 25 | 1 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 148 | 0 | 139 | 2 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 36 | 0 | 30 | 3 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 105 | 0 | 58 | 0 |
@@ -187,7 +187,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-kibana) | - | 22 | 0 | 16 | 1 |
| searchprofiler | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 0 | 0 | 0 | 0 |
| | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 455 | 0 | 238 | 0 |
-| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 188 | 0 | 120 | 33 |
+| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 187 | 0 | 119 | 33 |
| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | ESS customizations for Security Solution. | 6 | 0 | 6 | 0 |
| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | Serverless customizations for security. | 7 | 0 | 7 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | The core Serverless plugin, providing APIs to Serverless Project plugins. | 25 | 0 | 24 | 0 |
@@ -195,11 +195,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-kibana) | Serverless customizations for search. | 7 | 0 | 7 | 0 |
| | [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic/teams/kibana-cloud-security-posture) | - | 134 | 0 | 134 | 8 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds URL Service and sharing capabilities to Kibana | 136 | 0 | 73 | 15 |
-| | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 44 | 0 | 44 | 3 |
+| | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 45 | 0 | 45 | 4 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 22 | 1 | 22 | 1 |
| | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 269 | 0 | 73 | 1 |
| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 25 | 0 | 25 | 3 |
| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 10 | 0 | 10 | 0 |
+| | @simianhacker @flash1293 @dgieselaar | A manager for Streams | 12 | 7 | 12 | 2 |
| synthetics | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | This plugin visualizes data from Synthetics and Heartbeat, and integrates with other Observability solutions. | 0 | 0 | 0 | 1 |
| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 108 | 0 | 64 | 7 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 45 | 0 | 1 | 0 |
@@ -262,7 +263,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 87 | 0 | 87 | 11 |
| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 268 | 0 | 268 | 38 |
| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 337 | 0 | 336 | 0 |
-| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 11 | 0 | 11 | 0 |
+| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 12 | 0 | 12 | 0 |
| | [@elastic/security-defend-workflows](https://github.com/orgs/elastic/teams/security-defend-workflows) | - | 3 | 0 | 3 | 0 |
| | [@elastic/kibana-qa](https://github.com/orgs/elastic/teams/kibana-qa) | - | 12 | 0 | 12 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 4 | 0 | 1 | 0 |
@@ -290,8 +291,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 10 | 0 | 8 | 4 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 32 | 0 | 28 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 9 | 0 | 6 | 2 |
-| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 45 | 0 | 44 | 0 |
-| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 7 | 0 | 7 | 0 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 1 | 0 | 1 | 0 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 43 | 0 | 42 | 1 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 13 | 0 | 13 | 1 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 8 | 0 | 8 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 3 | 0 | 3 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 10 | 0 | 10 | 0 |
@@ -304,7 +306,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 99 | 0 | 0 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 7 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 5 | 0 | 5 | 0 |
-| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 103 | 0 | 27 | 0 |
+| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 105 | 0 | 26 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 20 | 0 | 17 | 3 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 13 | 0 | 13 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 8 | 0 | 1 | 0 |
@@ -416,6 +418,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 7 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 5 | 0 | 0 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 |
+| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2 | 0 | 2 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2 | 0 | 2 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2 | 0 | 2 | 1 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 1 |
@@ -444,8 +447,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 146 | 1 | 63 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 16 | 0 | 16 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 15 | 0 | 15 | 2 |
-| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 12 | 0 | 2 | 0 |
-| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 21 | 0 | 20 | 0 |
+| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 33 | 0 | 22 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 20 | 0 | 3 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 24 | 0 | 24 | 3 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 0 |
@@ -455,12 +457,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 29 | 0 | 4 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 15 | 0 | 14 | 1 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 0 |
-| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 2 | 0 |
+| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 2 | 0 |
| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 33 | 2 | 20 | 1 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 11 | 1 | 11 | 3 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 8 | 0 | 8 | 0 |
-| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 34 | 0 | 8 | 0 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 48 | 0 | 20 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 42 | 1 | 24 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 20 | 1 | 19 | 3 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 6 | 0 | 6 | 0 |
@@ -512,7 +514,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 16 | 0 | 8 | 0 |
| | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | - | 42 | 0 | 41 | 0 |
| | [@elastic/security-generative-ai](https://github.com/orgs/elastic/teams/security-generative-ai) | - | 169 | 0 | 140 | 10 |
-| | [@elastic/security-generative-ai](https://github.com/orgs/elastic/teams/security-generative-ai) | - | 401 | 0 | 370 | 0 |
+| | [@elastic/security-generative-ai](https://github.com/orgs/elastic/teams/security-generative-ai) | - | 400 | 0 | 369 | 0 |
| | [@elastic/obs-entities](https://github.com/orgs/elastic/teams/obs-entities) | - | 45 | 0 | 45 | 0 |
| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 55 | 0 | 40 | 7 |
| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 32 | 0 | 19 | 1 |
@@ -523,7 +525,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 277 | 1 | 216 | 36 |
| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 29 | 0 | 12 | 0 |
| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 83 | 0 | 74 | 0 |
-| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 203 | 0 | 191 | 12 |
+| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 205 | 0 | 193 | 12 |
| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 40 | 0 | 40 | 0 |
| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 52 | 0 | 52 | 1 |
| | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 44 | 0 | 17 | 3 |
@@ -549,8 +551,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 47 | 0 | 40 | 0 |
| | [@elastic/security-threat-hunting](https://github.com/orgs/elastic/teams/security-threat-hunting) | - | 85 | 0 | 80 | 2 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 75 | 0 | 73 | 0 |
-| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 124 | 3 | 124 | 0 |
-| | [@elastic/appex-ai-infra](https://github.com/orgs/elastic/teams/appex-ai-infra) | - | 121 | 0 | 38 | 1 |
+| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 126 | 3 | 126 | 0 |
+| | [@elastic/appex-ai-infra](https://github.com/orgs/elastic/teams/appex-ai-infra) | - | 124 | 0 | 41 | 1 |
| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 7 | 1 | 7 | 1 |
| | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 9 | 0 | 9 | 0 |
| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 52 | 12 | 43 | 0 |
@@ -577,7 +579,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 23 | 0 | 7 | 0 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 8 | 0 | 2 | 3 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 45 | 0 | 0 | 0 |
-| | [@elastic/appex-sharedux @elastic/kibana-management](https://github.com/orgs/elastic/teams/appex-sharedux ) | - | 139 | 0 | 138 | 0 |
+| | [@elastic/appex-sharedux @elastic/kibana-management](https://github.com/orgs/elastic/teams/appex-sharedux ) | - | 140 | 0 | 139 | 0 |
| | [@elastic/appex-sharedux @elastic/kibana-management](https://github.com/orgs/elastic/teams/appex-sharedux ) | - | 20 | 0 | 11 | 0 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 88 | 0 | 10 | 0 |
| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 56 | 0 | 6 | 0 |
@@ -615,7 +617,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 42 | 1 | 35 | 1 |
| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 32 | 0 | 0 | 0 |
| | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | - | 22 | 0 | 16 | 0 |
-| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 123 | 0 | 123 | 3 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 124 | 0 | 124 | 3 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 55 | 1 | 50 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 0 |
| | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 10 | 0 | 10 | 2 |
@@ -626,7 +628,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 4 | 0 | 4 | 1 |
| | [@elastic/security-detection-rule-management](https://github.com/orgs/elastic/teams/security-detection-rule-management) | - | 12 | 0 | 12 | 0 |
| | [@elastic/security-detection-rule-management](https://github.com/orgs/elastic/teams/security-detection-rule-management) | - | 15 | 0 | 15 | 0 |
-| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 45 | 0 | 45 | 10 |
+| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 45 | 0 | 45 | 9 |
| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 51 | 5 | 34 | 0 |
| | [@elastic/security-asset-management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 66 | 0 | 66 | 0 |
| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 5 | 0 | 5 | 0 |
@@ -640,12 +642,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 168 | 0 | 55 | 0 |
| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 13 | 0 | 7 | 0 |
| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 22 | 0 | 9 | 0 |
-| | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | - | 8 | 0 | 7 | 0 |
-| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 8 | 0 | 2 | 0 |
+| | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | - | 9 | 0 | 8 | 0 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 15 | 0 | 8 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 3 | 0 | 1 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 10 | 0 | 4 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 18 | 0 | 3 | 0 |
-| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 11 | 0 | 2 | 0 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 13 | 0 | 3 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 11 | 0 | 8 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 14 | 0 | 7 | 0 |
| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 18 | 0 | 18 | 0 |
@@ -764,7 +766,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 0 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 15 | 0 | 4 | 0 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 8 | 0 | 8 | 4 |
-| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 3 | 0 | 2 | 2 |
+| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 17 | 0 | 16 | 2 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 16 | 0 | 6 | 0 |
| | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 182 | 0 | 182 | 0 |
| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 20 | 0 | 12 | 0 |
@@ -790,7 +792,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 39 | 0 | 25 | 1 |
| | [@elastic/obs-knowledge-team](https://github.com/orgs/elastic/teams/obs-knowledge-team) | - | 86 | 0 | 86 | 1 |
| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 42 | 0 | 28 | 0 |
-| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 59 | 0 | 50 | 0 |
+| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 60 | 0 | 51 | 0 |
| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 9 | 0 | 8 | 0 |
| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Contains functionality for the unified data table which can be integrated into apps | 184 | 0 | 108 | 1 |
| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 18 | 0 | 17 | 5 |
diff --git a/api_docs/presentation_panel.mdx b/api_docs/presentation_panel.mdx
index 6f553b26a8156..fcdb0202034e3 100644
--- a/api_docs/presentation_panel.mdx
+++ b/api_docs/presentation_panel.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/presentationPanel
title: "presentationPanel"
image: https://source.unsplash.com/400x175/?github
description: API docs for the presentationPanel plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationPanel']
---
import presentationPanelObj from './presentation_panel.devdocs.json';
diff --git a/api_docs/presentation_util.devdocs.json b/api_docs/presentation_util.devdocs.json
index 3caa93409cc21..3ceb843da051a 100644
--- a/api_docs/presentation_util.devdocs.json
+++ b/api_docs/presentation_util.devdocs.json
@@ -2630,30 +2630,6 @@
}
],
"objects": [
- {
- "parentPluginId": "presentationUtil",
- "id": "def-common.defaultTheme$",
- "type": "Object",
- "tags": [],
- "label": "defaultTheme$",
- "description": [],
- "signature": [
- "Observable",
- "<",
- {
- "pluginId": "@kbn/core-theme-browser",
- "scope": "public",
- "docId": "kibKbnCoreThemeBrowserPluginApi",
- "section": "def-public.CoreTheme",
- "text": "CoreTheme"
- },
- ">"
- ],
- "path": "src/plugins/presentation_util/common/lib/utils/default_theme.ts",
- "deprecated": false,
- "trackAdoption": false,
- "initialIsOpen": false
- },
{
"parentPluginId": "presentationUtil",
"id": "def-common.environmentNames",
diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx
index c5d009168f365..d31ed581bc93b 100644
--- a/api_docs/presentation_util.mdx
+++ b/api_docs/presentation_util.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/presentationUtil
title: "presentationUtil"
image: https://source.unsplash.com/400x175/?github
description: API docs for the presentationUtil plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil']
---
import presentationUtilObj from './presentation_util.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 160 | 2 | 130 | 10 |
+| 159 | 2 | 129 | 10 |
## Client
diff --git a/api_docs/profiling.mdx b/api_docs/profiling.mdx
index 467ec0f381098..182321a4503db 100644
--- a/api_docs/profiling.mdx
+++ b/api_docs/profiling.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/profiling
title: "profiling"
image: https://source.unsplash.com/400x175/?github
description: API docs for the profiling plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profiling']
---
import profilingObj from './profiling.devdocs.json';
diff --git a/api_docs/profiling_data_access.mdx b/api_docs/profiling_data_access.mdx
index dba010c949b4b..fe9da1d9da48c 100644
--- a/api_docs/profiling_data_access.mdx
+++ b/api_docs/profiling_data_access.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/profilingDataAccess
title: "profilingDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the profilingDataAccess plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profilingDataAccess']
---
import profilingDataAccessObj from './profiling_data_access.devdocs.json';
diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx
index df0473bd4aa9f..85dd281521417 100644
--- a/api_docs/remote_clusters.mdx
+++ b/api_docs/remote_clusters.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/remoteClusters
title: "remoteClusters"
image: https://source.unsplash.com/400x175/?github
description: API docs for the remoteClusters plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters']
---
import remoteClustersObj from './remote_clusters.devdocs.json';
diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx
index 993eb152bfdf6..db7489c8e0f67 100644
--- a/api_docs/reporting.mdx
+++ b/api_docs/reporting.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/reporting
title: "reporting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the reporting plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting']
---
import reportingObj from './reporting.devdocs.json';
diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx
index 59444f770bcc0..82eb5d37a29f3 100644
--- a/api_docs/rollup.mdx
+++ b/api_docs/rollup.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/rollup
title: "rollup"
image: https://source.unsplash.com/400x175/?github
description: API docs for the rollup plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup']
---
import rollupObj from './rollup.devdocs.json';
diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx
index 97e65c73d8e48..7472749738569 100644
--- a/api_docs/rule_registry.mdx
+++ b/api_docs/rule_registry.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ruleRegistry
title: "ruleRegistry"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ruleRegistry plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry']
---
import ruleRegistryObj from './rule_registry.devdocs.json';
diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx
index 7ab741a2bca15..4122d9f383e73 100644
--- a/api_docs/runtime_fields.mdx
+++ b/api_docs/runtime_fields.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/runtimeFields
title: "runtimeFields"
image: https://source.unsplash.com/400x175/?github
description: API docs for the runtimeFields plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields']
---
import runtimeFieldsObj from './runtime_fields.devdocs.json';
diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx
index 2c05cf9711972..1de39b0c710aa 100644
--- a/api_docs/saved_objects.mdx
+++ b/api_docs/saved_objects.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjects
title: "savedObjects"
image: https://source.unsplash.com/400x175/?github
description: API docs for the savedObjects plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects']
---
import savedObjectsObj from './saved_objects.devdocs.json';
diff --git a/api_docs/saved_objects_finder.devdocs.json b/api_docs/saved_objects_finder.devdocs.json
index d33b50de2badc..866969ae30c37 100644
--- a/api_docs/saved_objects_finder.devdocs.json
+++ b/api_docs/saved_objects_finder.devdocs.json
@@ -36,6 +36,16 @@
"text": "SavedObjectsTaggingApi"
},
" | undefined) => (props: ",
+ {
+ "pluginId": "@kbn/shared-ux-table-persist",
+ "scope": "common",
+ "docId": "kibKbnSharedUxTablePersistPluginApi",
+ "section": "def-common.HOCProps",
+ "text": "HOCProps"
+ },
+ "<",
+ "SavedObjectFinderItem",
+ ", ",
{
"pluginId": "savedObjectsFinder",
"scope": "public",
@@ -43,7 +53,7 @@
"section": "def-public.SavedObjectFinderProps",
"text": "SavedObjectFinderProps"
},
- ") => React.JSX.Element"
+ ">) => React.JSX.Element"
],
"path": "src/plugins/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
@@ -126,6 +136,16 @@
"description": [],
"signature": [
"(props: ",
+ {
+ "pluginId": "@kbn/shared-ux-table-persist",
+ "scope": "common",
+ "docId": "kibKbnSharedUxTablePersistPluginApi",
+ "section": "def-common.HOCProps",
+ "text": "HOCProps"
+ },
+ "<",
+ "SavedObjectFinderItem",
+ ", ",
{
"pluginId": "savedObjectsFinder",
"scope": "public",
@@ -133,7 +153,7 @@
"section": "def-public.SavedObjectFinderProps",
"text": "SavedObjectFinderProps"
},
- ") => React.JSX.Element"
+ ">) => React.JSX.Element"
],
"path": "src/plugins/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
@@ -147,13 +167,24 @@
"label": "props",
"description": [],
"signature": [
+ {
+ "pluginId": "@kbn/shared-ux-table-persist",
+ "scope": "common",
+ "docId": "kibKbnSharedUxTablePersistPluginApi",
+ "section": "def-common.HOCProps",
+ "text": "HOCProps"
+ },
+ "<",
+ "SavedObjectFinderItem",
+ ", ",
{
"pluginId": "savedObjectsFinder",
"scope": "public",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-public.SavedObjectFinderProps",
"text": "SavedObjectFinderProps"
- }
+ },
+ ">"
],
"path": "src/plugins/saved_objects_finder/public/finder/index.tsx",
"deprecated": false,
diff --git a/api_docs/saved_objects_finder.mdx b/api_docs/saved_objects_finder.mdx
index d0d041a25f97d..8cf1ce9957e37 100644
--- a/api_docs/saved_objects_finder.mdx
+++ b/api_docs/saved_objects_finder.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsFinder
title: "savedObjectsFinder"
image: https://source.unsplash.com/400x175/?github
description: API docs for the savedObjectsFinder plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsFinder']
---
import savedObjectsFinderObj from './saved_objects_finder.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 25 | 0 | 25 | 0 |
+| 25 | 0 | 25 | 1 |
## Client
diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx
index bf1971eaff0bf..925106bd8d08c 100644
--- a/api_docs/saved_objects_management.mdx
+++ b/api_docs/saved_objects_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement
title: "savedObjectsManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the savedObjectsManagement plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement']
---
import savedObjectsManagementObj from './saved_objects_management.devdocs.json';
diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx
index 0dc9e70b7e20b..ca588d2b735f8 100644
--- a/api_docs/saved_objects_tagging.mdx
+++ b/api_docs/saved_objects_tagging.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging
title: "savedObjectsTagging"
image: https://source.unsplash.com/400x175/?github
description: API docs for the savedObjectsTagging plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging']
---
import savedObjectsTaggingObj from './saved_objects_tagging.devdocs.json';
diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx
index 2552cc1da3f05..74da07b00bf00 100644
--- a/api_docs/saved_objects_tagging_oss.mdx
+++ b/api_docs/saved_objects_tagging_oss.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss
title: "savedObjectsTaggingOss"
image: https://source.unsplash.com/400x175/?github
description: API docs for the savedObjectsTaggingOss plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss']
---
import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.devdocs.json';
diff --git a/api_docs/saved_search.mdx b/api_docs/saved_search.mdx
index a31f6047953ba..8e33b2a2c1702 100644
--- a/api_docs/saved_search.mdx
+++ b/api_docs/saved_search.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedSearch
title: "savedSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the savedSearch plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedSearch']
---
import savedSearchObj from './saved_search.devdocs.json';
diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx
index e4a9e97c087a3..461ebbc12aa3b 100644
--- a/api_docs/screenshot_mode.mdx
+++ b/api_docs/screenshot_mode.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotMode
title: "screenshotMode"
image: https://source.unsplash.com/400x175/?github
description: API docs for the screenshotMode plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode']
---
import screenshotModeObj from './screenshot_mode.devdocs.json';
diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx
index 0cbf39b53f559..e80ec2240e25d 100644
--- a/api_docs/screenshotting.mdx
+++ b/api_docs/screenshotting.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotting
title: "screenshotting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the screenshotting plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting']
---
import screenshottingObj from './screenshotting.devdocs.json';
diff --git a/api_docs/search_assistant.mdx b/api_docs/search_assistant.mdx
index cd14144900912..8dd97cd61ed81 100644
--- a/api_docs/search_assistant.mdx
+++ b/api_docs/search_assistant.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchAssistant
title: "searchAssistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the searchAssistant plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchAssistant']
---
import searchAssistantObj from './search_assistant.devdocs.json';
diff --git a/api_docs/search_connectors.mdx b/api_docs/search_connectors.mdx
index 966b3c94c3588..6cb52a719810d 100644
--- a/api_docs/search_connectors.mdx
+++ b/api_docs/search_connectors.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchConnectors
title: "searchConnectors"
image: https://source.unsplash.com/400x175/?github
description: API docs for the searchConnectors plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchConnectors']
---
import searchConnectorsObj from './search_connectors.devdocs.json';
diff --git a/api_docs/search_homepage.mdx b/api_docs/search_homepage.mdx
index 14f818e3c4513..399d01272324e 100644
--- a/api_docs/search_homepage.mdx
+++ b/api_docs/search_homepage.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchHomepage
title: "searchHomepage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the searchHomepage plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchHomepage']
---
import searchHomepageObj from './search_homepage.devdocs.json';
diff --git a/api_docs/search_indices.devdocs.json b/api_docs/search_indices.devdocs.json
index 11be05829ab55..a50dd817dbf4d 100644
--- a/api_docs/search_indices.devdocs.json
+++ b/api_docs/search_indices.devdocs.json
@@ -194,7 +194,7 @@
"label": "privileges",
"description": [],
"signature": [
- "{ canCreateApiKeys: boolean; canCreateIndex: boolean; }"
+ "{ canCreateApiKeys: boolean; canManageIndex: boolean; canDeleteDocuments: boolean; }"
],
"path": "x-pack/plugins/search_indices/common/types.ts",
"deprecated": false,
diff --git a/api_docs/search_indices.mdx b/api_docs/search_indices.mdx
index 5623668a1683a..df245f5f03571 100644
--- a/api_docs/search_indices.mdx
+++ b/api_docs/search_indices.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchIndices
title: "searchIndices"
image: https://source.unsplash.com/400x175/?github
description: API docs for the searchIndices plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchIndices']
---
import searchIndicesObj from './search_indices.devdocs.json';
diff --git a/api_docs/search_inference_endpoints.mdx b/api_docs/search_inference_endpoints.mdx
index 9add4c8ebcf33..157d2776a67e7 100644
--- a/api_docs/search_inference_endpoints.mdx
+++ b/api_docs/search_inference_endpoints.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchInferenceEndpoints
title: "searchInferenceEndpoints"
image: https://source.unsplash.com/400x175/?github
description: API docs for the searchInferenceEndpoints plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchInferenceEndpoints']
---
import searchInferenceEndpointsObj from './search_inference_endpoints.devdocs.json';
diff --git a/api_docs/search_notebooks.mdx b/api_docs/search_notebooks.mdx
index d888e968bc151..ddb5240a9c75c 100644
--- a/api_docs/search_notebooks.mdx
+++ b/api_docs/search_notebooks.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchNotebooks
title: "searchNotebooks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the searchNotebooks plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchNotebooks']
---
import searchNotebooksObj from './search_notebooks.devdocs.json';
diff --git a/api_docs/search_playground.mdx b/api_docs/search_playground.mdx
index 5ca09fde3e9bd..6b8495406fab3 100644
--- a/api_docs/search_playground.mdx
+++ b/api_docs/search_playground.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchPlayground
title: "searchPlayground"
image: https://source.unsplash.com/400x175/?github
description: API docs for the searchPlayground plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchPlayground']
---
import searchPlaygroundObj from './search_playground.devdocs.json';
diff --git a/api_docs/security.mdx b/api_docs/security.mdx
index 423a75b2ea6da..f3ebd9cff5f9e 100644
--- a/api_docs/security.mdx
+++ b/api_docs/security.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/security
title: "security"
image: https://source.unsplash.com/400x175/?github
description: API docs for the security plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security']
---
import securityObj from './security.devdocs.json';
diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json
index 34c21c3ec482d..be3a215235f75 100644
--- a/api_docs/security_solution.devdocs.json
+++ b/api_docs/security_solution.devdocs.json
@@ -1622,17 +1622,6 @@
"deprecated": false,
"trackAdoption": false
},
- {
- "parentPluginId": "securitySolution",
- "id": "def-public.TimelineModel.isLoading",
- "type": "boolean",
- "tags": [],
- "label": "isLoading",
- "description": [],
- "path": "x-pack/plugins/security_solution/public/timelines/store/model.ts",
- "deprecated": false,
- "trackAdoption": false
- },
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.selectAll",
diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx
index 995444fc17b65..eabc79c042d67 100644
--- a/api_docs/security_solution.mdx
+++ b/api_docs/security_solution.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolution
title: "securitySolution"
image: https://source.unsplash.com/400x175/?github
description: API docs for the securitySolution plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution']
---
import securitySolutionObj from './security_solution.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/secur
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 188 | 0 | 120 | 33 |
+| 187 | 0 | 119 | 33 |
## Client
diff --git a/api_docs/security_solution_ess.mdx b/api_docs/security_solution_ess.mdx
index a95ca33550eb1..94fdf277f8368 100644
--- a/api_docs/security_solution_ess.mdx
+++ b/api_docs/security_solution_ess.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolutionEss
title: "securitySolutionEss"
image: https://source.unsplash.com/400x175/?github
description: API docs for the securitySolutionEss plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolutionEss']
---
import securitySolutionEssObj from './security_solution_ess.devdocs.json';
diff --git a/api_docs/security_solution_serverless.mdx b/api_docs/security_solution_serverless.mdx
index e3ab6cfa86f68..e70dcc4730fc3 100644
--- a/api_docs/security_solution_serverless.mdx
+++ b/api_docs/security_solution_serverless.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolutionServerless
title: "securitySolutionServerless"
image: https://source.unsplash.com/400x175/?github
description: API docs for the securitySolutionServerless plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolutionServerless']
---
import securitySolutionServerlessObj from './security_solution_serverless.devdocs.json';
diff --git a/api_docs/serverless.mdx b/api_docs/serverless.mdx
index 55350e1dfde48..d2d0f195fa048 100644
--- a/api_docs/serverless.mdx
+++ b/api_docs/serverless.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverless
title: "serverless"
image: https://source.unsplash.com/400x175/?github
description: API docs for the serverless plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverless']
---
import serverlessObj from './serverless.devdocs.json';
diff --git a/api_docs/serverless_observability.mdx b/api_docs/serverless_observability.mdx
index 0a2a43223205d..6210a8772fd0e 100644
--- a/api_docs/serverless_observability.mdx
+++ b/api_docs/serverless_observability.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessObservability
title: "serverlessObservability"
image: https://source.unsplash.com/400x175/?github
description: API docs for the serverlessObservability plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessObservability']
---
import serverlessObservabilityObj from './serverless_observability.devdocs.json';
diff --git a/api_docs/serverless_search.mdx b/api_docs/serverless_search.mdx
index 01cbb5835f29f..2d7e7a0e7d7c4 100644
--- a/api_docs/serverless_search.mdx
+++ b/api_docs/serverless_search.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessSearch
title: "serverlessSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the serverlessSearch plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessSearch']
---
import serverlessSearchObj from './serverless_search.devdocs.json';
diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx
index 6495f14450e35..8b40bb2dd322e 100644
--- a/api_docs/session_view.mdx
+++ b/api_docs/session_view.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/sessionView
title: "sessionView"
image: https://source.unsplash.com/400x175/?github
description: API docs for the sessionView plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView']
---
import sessionViewObj from './session_view.devdocs.json';
diff --git a/api_docs/share.mdx b/api_docs/share.mdx
index 58759baf5262c..2139cb04491bb 100644
--- a/api_docs/share.mdx
+++ b/api_docs/share.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/share
title: "share"
image: https://source.unsplash.com/400x175/?github
description: API docs for the share plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share']
---
import shareObj from './share.devdocs.json';
diff --git a/api_docs/slo.devdocs.json b/api_docs/slo.devdocs.json
index 8c60a42bac56e..6252ccc31c977 100644
--- a/api_docs/slo.devdocs.json
+++ b/api_docs/slo.devdocs.json
@@ -604,6 +604,26 @@
"deprecated": false,
"trackAdoption": false
},
+ {
+ "parentPluginId": "slo",
+ "id": "def-public.SLOPublicPluginsStart.discoverShared",
+ "type": "Object",
+ "tags": [],
+ "label": "discoverShared",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "discoverShared",
+ "scope": "public",
+ "docId": "kibDiscoverSharedPluginApi",
+ "section": "def-public.DiscoverSharedPublicStart",
+ "text": "DiscoverSharedPublicStart"
+ }
+ ],
+ "path": "x-pack/plugins/observability_solution/slo/public/types.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.embeddable",
@@ -1072,7 +1092,17 @@
"label": "SLOPublicStart",
"description": [],
"signature": [
- "{ getCreateSLOFlyout: React.FunctionComponent<{}>; }"
+ "{ getCreateSLOFlyout: React.FunctionComponent<{ onClose: () => void; initialValues?: ",
+ {
+ "pluginId": "@kbn/utility-types",
+ "scope": "common",
+ "docId": "kibKbnUtilityTypesPluginApi",
+ "section": "def-common.RecursivePartial",
+ "text": "RecursivePartial"
+ },
+ "<",
+ "CreateSLOForm",
+ "<{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"cardinality\" | \"last_value\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }>> | undefined; }>; }"
],
"path": "x-pack/plugins/observability_solution/slo/public/types.ts",
"deprecated": false,
diff --git a/api_docs/slo.mdx b/api_docs/slo.mdx
index 5fb1a5507d825..b22401ebe551a 100644
--- a/api_docs/slo.mdx
+++ b/api_docs/slo.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/slo
title: "slo"
image: https://source.unsplash.com/400x175/?github
description: API docs for the slo plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'slo']
---
import sloObj from './slo.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
-| 44 | 0 | 44 | 3 |
+| 45 | 0 | 45 | 4 |
## Client
diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx
index bca5c3ef90bee..46db8d0a9994e 100644
--- a/api_docs/snapshot_restore.mdx
+++ b/api_docs/snapshot_restore.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/snapshotRestore
title: "snapshotRestore"
image: https://source.unsplash.com/400x175/?github
description: API docs for the snapshotRestore plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore']
---
import snapshotRestoreObj from './snapshot_restore.devdocs.json';
diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx
index 6f604ca151814..1d7f1b0c7bfc6 100644
--- a/api_docs/spaces.mdx
+++ b/api_docs/spaces.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/spaces
title: "spaces"
image: https://source.unsplash.com/400x175/?github
description: API docs for the spaces plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces']
---
import spacesObj from './spaces.devdocs.json';
diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx
index 15c090db56ed6..15d17a8701e2a 100644
--- a/api_docs/stack_alerts.mdx
+++ b/api_docs/stack_alerts.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackAlerts
title: "stackAlerts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the stackAlerts plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts']
---
import stackAlertsObj from './stack_alerts.devdocs.json';
diff --git a/api_docs/stack_connectors.mdx b/api_docs/stack_connectors.mdx
index f947fc50e3f1c..a77013bb1792d 100644
--- a/api_docs/stack_connectors.mdx
+++ b/api_docs/stack_connectors.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackConnectors
title: "stackConnectors"
image: https://source.unsplash.com/400x175/?github
description: API docs for the stackConnectors plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackConnectors']
---
import stackConnectorsObj from './stack_connectors.devdocs.json';
diff --git a/api_docs/streams.devdocs.json b/api_docs/streams.devdocs.json
new file mode 100644
index 0000000000000..02800505b0823
--- /dev/null
+++ b/api_docs/streams.devdocs.json
@@ -0,0 +1,453 @@
+{
+ "id": "streams",
+ "client": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ },
+ "server": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsConfig",
+ "type": "Type",
+ "tags": [],
+ "label": "StreamsConfig",
+ "description": [],
+ "signature": [
+ "{}"
+ ],
+ "path": "x-pack/plugins/streams/common/config.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository",
+ "type": "Type",
+ "tags": [],
+ "label": "StreamsRouteRepository",
+ "description": [],
+ "signature": [
+ "{ \"GET /api/streams 2023-10-31\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"GET /api/streams 2023-10-31\", Zod.ZodObject<{}, \"strip\", Zod.ZodTypeAny, {}, {}>, ",
+ "StreamsRouteHandlerResources",
+ ", ",
+ {
+ "pluginId": "@kbn/core-http-server",
+ "scope": "server",
+ "docId": "kibKbnCoreHttpServerPluginApi",
+ "section": "def-server.IKibanaResponse",
+ "text": "IKibanaResponse"
+ },
+ ", ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.DefaultRouteCreateOptions",
+ "text": "DefaultRouteCreateOptions"
+ },
+ ">; \"DELETE /api/streams/{id} 2023-10-31\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"DELETE /api/streams/{id} 2023-10-31\", Zod.ZodObject<{ path: Zod.ZodObject<{ id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; }, { id: string; }>; }, \"strip\", Zod.ZodTypeAny, { path: { id: string; }; }, { path: { id: string; }; }>, ",
+ "StreamsRouteHandlerResources",
+ ", ",
+ {
+ "pluginId": "@kbn/core-http-server",
+ "scope": "server",
+ "docId": "kibKbnCoreHttpServerPluginApi",
+ "section": "def-server.IKibanaResponse",
+ "text": "IKibanaResponse"
+ },
+ ", ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.DefaultRouteCreateOptions",
+ "text": "DefaultRouteCreateOptions"
+ },
+ ">; \"PUT /api/streams/{id} 2023-10-31\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"PUT /api/streams/{id} 2023-10-31\", Zod.ZodObject<{ path: Zod.ZodObject<{ id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; }, { id: string; }>; body: Zod.ZodObject<{ processing: Zod.ZodDefault>; config: Zod.ZodDiscriminatedUnion<\"type\", [Zod.ZodObject<{ type: Zod.ZodLiteral<\"grok\">; field: Zod.ZodString; patterns: Zod.ZodArray; pattern_definitions: Zod.ZodOptional>; }, \"strip\", Zod.ZodTypeAny, { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; }, { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; }>, Zod.ZodObject<{ type: Zod.ZodLiteral<\"dissect\">; field: Zod.ZodString; pattern: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { type: \"dissect\"; field: string; pattern: string; }, { type: \"dissect\"; field: string; pattern: string; }>]>; }, \"strip\", Zod.ZodTypeAny, { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }, { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }>, \"many\">>; fields: Zod.ZodDefault; }, \"strip\", Zod.ZodTypeAny, { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }, { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }>, \"many\">>; children: Zod.ZodDefault; }, \"strip\", Zod.ZodTypeAny, { id: string; condition?: ",
+ "Condition",
+ "; }, { id: string; condition?: ",
+ "Condition",
+ "; }>, \"many\">>; }, \"strip\", Zod.ZodTypeAny, { children: { id: string; condition?: ",
+ "Condition",
+ "; }[]; fields: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[]; processing: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[]; }, { children?: { id: string; condition?: ",
+ "Condition",
+ "; }[] | undefined; fields?: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[] | undefined; processing?: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[] | undefined; }>; }, \"strip\", Zod.ZodTypeAny, { path: { id: string; }; body: { children: { id: string; condition?: ",
+ "Condition",
+ "; }[]; fields: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[]; processing: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[]; }; }, { path: { id: string; }; body: { children?: { id: string; condition?: ",
+ "Condition",
+ "; }[] | undefined; fields?: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[] | undefined; processing?: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[] | undefined; }; }>, ",
+ "StreamsRouteHandlerResources",
+ ", ",
+ {
+ "pluginId": "@kbn/core-http-server",
+ "scope": "server",
+ "docId": "kibKbnCoreHttpServerPluginApi",
+ "section": "def-server.IKibanaResponse",
+ "text": "IKibanaResponse"
+ },
+ ", ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.DefaultRouteCreateOptions",
+ "text": "DefaultRouteCreateOptions"
+ },
+ ">; \"GET /api/streams/{id} 2023-10-31\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"GET /api/streams/{id} 2023-10-31\", Zod.ZodObject<{ path: Zod.ZodObject<{ id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; }, { id: string; }>; }, \"strip\", Zod.ZodTypeAny, { path: { id: string; }; }, { path: { id: string; }; }>, ",
+ "StreamsRouteHandlerResources",
+ ", ",
+ {
+ "pluginId": "@kbn/core-http-server",
+ "scope": "server",
+ "docId": "kibKbnCoreHttpServerPluginApi",
+ "section": "def-server.IKibanaResponse",
+ "text": "IKibanaResponse"
+ },
+ ", ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.DefaultRouteCreateOptions",
+ "text": "DefaultRouteCreateOptions"
+ },
+ ">; \"POST /api/streams/{id}/_fork 2023-10-31\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /api/streams/{id}/_fork 2023-10-31\", Zod.ZodObject<{ path: Zod.ZodObject<{ id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; }, { id: string; }>; body: Zod.ZodObject<{ stream: Zod.ZodObject>; config: Zod.ZodDiscriminatedUnion<\"type\", [Zod.ZodObject<{ type: Zod.ZodLiteral<\"grok\">; field: Zod.ZodString; patterns: Zod.ZodArray; pattern_definitions: Zod.ZodOptional>; }, \"strip\", Zod.ZodTypeAny, { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; }, { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; }>, Zod.ZodObject<{ type: Zod.ZodLiteral<\"dissect\">; field: Zod.ZodString; pattern: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { type: \"dissect\"; field: string; pattern: string; }, { type: \"dissect\"; field: string; pattern: string; }>]>; }, \"strip\", Zod.ZodTypeAny, { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }, { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }>, \"many\">>; fields: Zod.ZodDefault; }, \"strip\", Zod.ZodTypeAny, { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }, { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }>, \"many\">>; children: Zod.ZodDefault; }, \"strip\", Zod.ZodTypeAny, { id: string; condition?: ",
+ "Condition",
+ "; }, { id: string; condition?: ",
+ "Condition",
+ "; }>, \"many\">>; }, { id: Zod.ZodString; }>, \"children\">, \"strip\", Zod.ZodTypeAny, { id: string; fields: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[]; processing: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[]; }, { id: string; fields?: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[] | undefined; processing?: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[] | undefined; }>; condition: Zod.ZodType<",
+ "Condition",
+ ", Zod.ZodTypeDef, ",
+ "Condition",
+ ">; }, \"strip\", Zod.ZodTypeAny, { stream: { id: string; fields: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[]; processing: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[]; }; condition?: ",
+ "Condition",
+ "; }, { stream: { id: string; fields?: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[] | undefined; processing?: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[] | undefined; }; condition?: ",
+ "Condition",
+ "; }>; }, \"strip\", Zod.ZodTypeAny, { path: { id: string; }; body: { stream: { id: string; fields: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[]; processing: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[]; }; condition?: ",
+ "Condition",
+ "; }; }, { path: { id: string; }; body: { stream: { id: string; fields?: { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; name: string; }[] | undefined; processing?: { config: { type: \"grok\"; field: string; patterns: string[]; pattern_definitions?: Record | undefined; } | { type: \"dissect\"; field: string; pattern: string; }; condition?: ",
+ "Condition",
+ "; }[] | undefined; }; condition?: ",
+ "Condition",
+ "; }; }>, ",
+ "StreamsRouteHandlerResources",
+ ", ",
+ {
+ "pluginId": "@kbn/core-http-server",
+ "scope": "server",
+ "docId": "kibKbnCoreHttpServerPluginApi",
+ "section": "def-server.IKibanaResponse",
+ "text": "IKibanaResponse"
+ },
+ ", ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.DefaultRouteCreateOptions",
+ "text": "DefaultRouteCreateOptions"
+ },
+ ">; \"POST /api/streams/_resync 2023-10-31\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /api/streams/_resync 2023-10-31\", Zod.ZodObject<{}, \"strip\", Zod.ZodTypeAny, {}, {}>, ",
+ "StreamsRouteHandlerResources",
+ ", ",
+ {
+ "pluginId": "@kbn/core-http-server",
+ "scope": "server",
+ "docId": "kibKbnCoreHttpServerPluginApi",
+ "section": "def-server.IKibanaResponse",
+ "text": "IKibanaResponse"
+ },
+ ", ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.DefaultRouteCreateOptions",
+ "text": "DefaultRouteCreateOptions"
+ },
+ ">; \"POST /api/streams/_enable 2023-10-31\": ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.ServerRoute",
+ "text": "ServerRoute"
+ },
+ "<\"POST /api/streams/_enable 2023-10-31\", Zod.ZodObject<{}, \"strip\", Zod.ZodTypeAny, {}, {}>, ",
+ "StreamsRouteHandlerResources",
+ ", ",
+ {
+ "pluginId": "@kbn/core-http-server",
+ "scope": "server",
+ "docId": "kibKbnCoreHttpServerPluginApi",
+ "section": "def-server.IKibanaResponse",
+ "text": "IKibanaResponse"
+ },
+ ", ",
+ {
+ "pluginId": "@kbn/server-route-repository-utils",
+ "scope": "common",
+ "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
+ "section": "def-common.DefaultRouteCreateOptions",
+ "text": "DefaultRouteCreateOptions"
+ },
+ ">; }"
+ ],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ }
+ ],
+ "objects": [
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository",
+ "type": "Object",
+ "tags": [],
+ "label": "StreamsRouteRepository",
+ "description": [],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository.Unnamed",
+ "type": "Any",
+ "tags": [],
+ "label": "Unnamed",
+ "description": [],
+ "signature": [
+ "any"
+ ],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository.Unnamed",
+ "type": "Any",
+ "tags": [],
+ "label": "Unnamed",
+ "description": [],
+ "signature": [
+ "any"
+ ],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository.Unnamed",
+ "type": "Any",
+ "tags": [],
+ "label": "Unnamed",
+ "description": [],
+ "signature": [
+ "any"
+ ],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository.Unnamed",
+ "type": "Any",
+ "tags": [],
+ "label": "Unnamed",
+ "description": [],
+ "signature": [
+ "any"
+ ],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository.Unnamed",
+ "type": "Any",
+ "tags": [],
+ "label": "Unnamed",
+ "description": [],
+ "signature": [
+ "any"
+ ],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository.Unnamed",
+ "type": "Any",
+ "tags": [],
+ "label": "Unnamed",
+ "description": [],
+ "signature": [
+ "any"
+ ],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ },
+ {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsRouteRepository.Unnamed",
+ "type": "Any",
+ "tags": [],
+ "label": "Unnamed",
+ "description": [],
+ "signature": [
+ "any"
+ ],
+ "path": "x-pack/plugins/streams/server/routes/index.ts",
+ "deprecated": false,
+ "trackAdoption": false
+ }
+ ],
+ "initialIsOpen": false
+ }
+ ],
+ "setup": {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsPluginSetup",
+ "type": "Interface",
+ "tags": [],
+ "label": "StreamsPluginSetup",
+ "description": [],
+ "path": "x-pack/plugins/streams/server/plugin.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [],
+ "lifecycle": "setup",
+ "initialIsOpen": true
+ },
+ "start": {
+ "parentPluginId": "streams",
+ "id": "def-server.StreamsPluginStart",
+ "type": "Interface",
+ "tags": [],
+ "label": "StreamsPluginStart",
+ "description": [],
+ "path": "x-pack/plugins/streams/server/plugin.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "children": [],
+ "lifecycle": "start",
+ "initialIsOpen": true
+ }
+ },
+ "common": {
+ "classes": [],
+ "functions": [],
+ "interfaces": [],
+ "enums": [],
+ "misc": [],
+ "objects": []
+ }
+}
\ No newline at end of file
diff --git a/api_docs/streams.mdx b/api_docs/streams.mdx
new file mode 100644
index 0000000000000..51481a76fb2b0
--- /dev/null
+++ b/api_docs/streams.mdx
@@ -0,0 +1,39 @@
+---
+####
+#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
+#### Reach out in #docs-engineering for more info.
+####
+id: kibStreamsPluginApi
+slug: /kibana-dev-docs/api/streams
+title: "streams"
+image: https://source.unsplash.com/400x175/?github
+description: API docs for the streams plugin
+date: 2024-11-19
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'streams']
+---
+import streamsObj from './streams.devdocs.json';
+
+A manager for Streams
+
+Contact @simianhacker @flash1293 @dgieselaar for questions regarding this plugin.
+
+**Code health stats**
+
+| Public API count | Any count | Items lacking comments | Missing exports |
+|-------------------|-----------|------------------------|-----------------|
+| 12 | 7 | 12 | 2 |
+
+## Server
+
+### Setup
+
+
+### Start
+
+
+### Objects
+
+
+### Consts, variables and types
+
+
diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx
index 7bedbc9b70e17..7a13f204d27d5 100644
--- a/api_docs/task_manager.mdx
+++ b/api_docs/task_manager.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/taskManager
title: "taskManager"
image: https://source.unsplash.com/400x175/?github
description: API docs for the taskManager plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager']
---
import taskManagerObj from './task_manager.devdocs.json';
diff --git a/api_docs/telemetry.devdocs.json b/api_docs/telemetry.devdocs.json
index e5f56d87cc9ba..4ea397d13220c 100644
--- a/api_docs/telemetry.devdocs.json
+++ b/api_docs/telemetry.devdocs.json
@@ -630,7 +630,7 @@
"When the data comes from a matching index-pattern, the name of the pattern"
],
"signature": [
- "\"search\" | \"logstash\" | \"alerts\" | \"apm\" | \"metricbeat\" | \"suricata\" | \"zeek\" | \"enterprise-search\" | \"app-search\" | \"magento2\" | \"magento\" | \"shopify\" | \"wordpress\" | \"drupal\" | \"joomla\" | \"sharepoint\" | \"squarespace\" | \"sitecore\" | \"weebly\" | \"acquia\" | \"filebeat\" | \"generic-filebeat\" | \"generic-metricbeat\" | \"heartbeat\" | \"generic-heartbeat\" | \"generic-logstash\" | \"fluentd\" | \"telegraf\" | \"prometheusbeat\" | \"fluentbit\" | \"nginx\" | \"apache\" | \"dsns-logs\" | \"generic-logs\" | \"endgame\" | \"logs-endpoint\" | \"metrics-endpoint\" | \"siem-signals\" | \"auditbeat\" | \"winlogbeat\" | \"packetbeat\" | \"tomcat\" | \"artifactory\" | \"aruba\" | \"barracuda\" | \"bluecoat\" | \"arcsight\" | \"checkpoint\" | \"cisco\" | \"citrix\" | \"cyberark\" | \"cylance\" | \"fireeye\" | \"fortinet\" | \"infoblox\" | \"kaspersky\" | \"mcafee\" | \"paloaltonetworks\" | \"rsa\" | \"snort\" | \"sonicwall\" | \"sophos\" | \"squid\" | \"symantec\" | \"tippingpoint\" | \"trendmicro\" | \"tripwire\" | \"zscaler\" | \"sigma_doc\" | \"ecs-corelight\" | \"wazuh\" | \"meow\" | \"host_risk_score\" | \"user_risk_score\" | undefined"
+ "\"search\" | \"logstash\" | \"alerts\" | \"apm\" | \"metricbeat\" | \"suricata\" | \"zeek\" | \"enterprise-search\" | \"app-search\" | \"magento2\" | \"magento\" | \"shopify\" | \"wordpress\" | \"drupal\" | \"joomla\" | \"sharepoint\" | \"squarespace\" | \"sitecore\" | \"weebly\" | \"acquia\" | \"filebeat\" | \"generic-filebeat\" | \"generic-metricbeat\" | \"functionbeat\" | \"generic-functionbeat\" | \"heartbeat\" | \"generic-heartbeat\" | \"generic-logstash\" | \"fluentd\" | \"telegraf\" | \"prometheusbeat\" | \"fluentbit\" | \"nginx\" | \"apache\" | \"dsns-logs\" | \"generic-logs\" | \"endgame\" | \"logs-endpoint\" | \"metrics-endpoint\" | \"siem-signals\" | \"auditbeat\" | \"winlogbeat\" | \"packetbeat\" | \"tomcat\" | \"artifactory\" | \"aruba\" | \"barracuda\" | \"bluecoat\" | \"arcsight\" | \"checkpoint\" | \"cisco\" | \"citrix\" | \"cyberark\" | \"cylance\" | \"fireeye\" | \"fortinet\" | \"infoblox\" | \"kaspersky\" | \"mcafee\" | \"paloaltonetworks\" | \"rsa\" | \"snort\" | \"sonicwall\" | \"sophos\" | \"squid\" | \"symantec\" | \"tippingpoint\" | \"trendmicro\" | \"tripwire\" | \"zscaler\" | \"sigma_doc\" | \"ecs-corelight\" | \"wazuh\" | \"meow\" | \"host_risk_score\" | \"user_risk_score\" | undefined"
],
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"deprecated": false,
@@ -860,4 +860,4 @@
"misc": [],
"objects": []
}
-}
+}
\ No newline at end of file
diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx
index db072bd82bbd3..bfb78a2f949e4 100644
--- a/api_docs/telemetry.mdx
+++ b/api_docs/telemetry.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetry
title: "telemetry"
image: https://source.unsplash.com/400x175/?github
description: API docs for the telemetry plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry']
---
import telemetryObj from './telemetry.devdocs.json';
diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx
index 08106028d4231..5861a8251a767 100644
--- a/api_docs/telemetry_collection_manager.mdx
+++ b/api_docs/telemetry_collection_manager.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager
title: "telemetryCollectionManager"
image: https://source.unsplash.com/400x175/?github
description: API docs for the telemetryCollectionManager plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager']
---
import telemetryCollectionManagerObj from './telemetry_collection_manager.devdocs.json';
diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx
index 0a85240a6e633..b92670a8084b8 100644
--- a/api_docs/telemetry_management_section.mdx
+++ b/api_docs/telemetry_management_section.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection
title: "telemetryManagementSection"
image: https://source.unsplash.com/400x175/?github
description: API docs for the telemetryManagementSection plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection']
---
import telemetryManagementSectionObj from './telemetry_management_section.devdocs.json';
diff --git a/api_docs/threat_intelligence.mdx b/api_docs/threat_intelligence.mdx
index d689fb5cd9b65..ed0ce98e5da82 100644
--- a/api_docs/threat_intelligence.mdx
+++ b/api_docs/threat_intelligence.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/threatIntelligence
title: "threatIntelligence"
image: https://source.unsplash.com/400x175/?github
description: API docs for the threatIntelligence plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'threatIntelligence']
---
import threatIntelligenceObj from './threat_intelligence.devdocs.json';
diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx
index db06f7cacad46..50635b3ce597b 100644
--- a/api_docs/timelines.mdx
+++ b/api_docs/timelines.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/timelines
title: "timelines"
image: https://source.unsplash.com/400x175/?github
description: API docs for the timelines plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines']
---
import timelinesObj from './timelines.devdocs.json';
diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx
index 0d18a3ca3cca2..d1d34de64765d 100644
--- a/api_docs/transform.mdx
+++ b/api_docs/transform.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/transform
title: "transform"
image: https://source.unsplash.com/400x175/?github
description: API docs for the transform plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform']
---
import transformObj from './transform.devdocs.json';
diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx
index 28ea40fcec5a1..2ab50bd744c93 100644
--- a/api_docs/triggers_actions_ui.mdx
+++ b/api_docs/triggers_actions_ui.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi
title: "triggersActionsUi"
image: https://source.unsplash.com/400x175/?github
description: API docs for the triggersActionsUi plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi']
---
import triggersActionsUiObj from './triggers_actions_ui.devdocs.json';
diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx
index b620a2382e6a9..33176238a3d4c 100644
--- a/api_docs/ui_actions.mdx
+++ b/api_docs/ui_actions.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActions
title: "uiActions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the uiActions plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions']
---
import uiActionsObj from './ui_actions.devdocs.json';
diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx
index 59968fbb7c91d..2bd93d9aac558 100644
--- a/api_docs/ui_actions_enhanced.mdx
+++ b/api_docs/ui_actions_enhanced.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced
title: "uiActionsEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the uiActionsEnhanced plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced']
---
import uiActionsEnhancedObj from './ui_actions_enhanced.devdocs.json';
diff --git a/api_docs/unified_doc_viewer.mdx b/api_docs/unified_doc_viewer.mdx
index ac18054ff2245..a44fb45c590f5 100644
--- a/api_docs/unified_doc_viewer.mdx
+++ b/api_docs/unified_doc_viewer.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedDocViewer
title: "unifiedDocViewer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the unifiedDocViewer plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedDocViewer']
---
import unifiedDocViewerObj from './unified_doc_viewer.devdocs.json';
diff --git a/api_docs/unified_histogram.mdx b/api_docs/unified_histogram.mdx
index 70dafb575e756..ca05464f6756d 100644
--- a/api_docs/unified_histogram.mdx
+++ b/api_docs/unified_histogram.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedHistogram
title: "unifiedHistogram"
image: https://source.unsplash.com/400x175/?github
description: API docs for the unifiedHistogram plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedHistogram']
---
import unifiedHistogramObj from './unified_histogram.devdocs.json';
diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx
index a0875c423685d..18690587f94c9 100644
--- a/api_docs/unified_search.mdx
+++ b/api_docs/unified_search.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch
title: "unifiedSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the unifiedSearch plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch']
---
import unifiedSearchObj from './unified_search.devdocs.json';
diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx
index e0df4720cdd04..a3918a98aeaf0 100644
--- a/api_docs/unified_search_autocomplete.mdx
+++ b/api_docs/unified_search_autocomplete.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete
title: "unifiedSearch.autocomplete"
image: https://source.unsplash.com/400x175/?github
description: API docs for the unifiedSearch.autocomplete plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete']
---
import unifiedSearchAutocompleteObj from './unified_search_autocomplete.devdocs.json';
diff --git a/api_docs/uptime.mdx b/api_docs/uptime.mdx
index 9451b17158c33..1f30689e4767a 100644
--- a/api_docs/uptime.mdx
+++ b/api_docs/uptime.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uptime
title: "uptime"
image: https://source.unsplash.com/400x175/?github
description: API docs for the uptime plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uptime']
---
import uptimeObj from './uptime.devdocs.json';
diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx
index 9336bfed6ecde..1da3998e7d737 100644
--- a/api_docs/url_forwarding.mdx
+++ b/api_docs/url_forwarding.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/urlForwarding
title: "urlForwarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the urlForwarding plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding']
---
import urlForwardingObj from './url_forwarding.devdocs.json';
diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx
index 09bc86b6ffdb9..8b5f81cd130c9 100644
--- a/api_docs/usage_collection.mdx
+++ b/api_docs/usage_collection.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/usageCollection
title: "usageCollection"
image: https://source.unsplash.com/400x175/?github
description: API docs for the usageCollection plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection']
---
import usageCollectionObj from './usage_collection.devdocs.json';
diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx
index e43fcbbdfbcec..d2c6eb2eac9fb 100644
--- a/api_docs/ux.mdx
+++ b/api_docs/ux.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ux
title: "ux"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ux plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux']
---
import uxObj from './ux.devdocs.json';
diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx
index 751c92ebd0d44..28d6baa8e07b6 100644
--- a/api_docs/vis_default_editor.mdx
+++ b/api_docs/vis_default_editor.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor
title: "visDefaultEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visDefaultEditor plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor']
---
import visDefaultEditorObj from './vis_default_editor.devdocs.json';
diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx
index 89c02f23a50b3..82630aad9287a 100644
--- a/api_docs/vis_type_gauge.mdx
+++ b/api_docs/vis_type_gauge.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeGauge
title: "visTypeGauge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypeGauge plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge']
---
import visTypeGaugeObj from './vis_type_gauge.devdocs.json';
diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx
index 70f7cea056bb1..8ecee7156cd84 100644
--- a/api_docs/vis_type_heatmap.mdx
+++ b/api_docs/vis_type_heatmap.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap
title: "visTypeHeatmap"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypeHeatmap plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap']
---
import visTypeHeatmapObj from './vis_type_heatmap.devdocs.json';
diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx
index 8f59635cceb79..2fed52ab7e710 100644
--- a/api_docs/vis_type_pie.mdx
+++ b/api_docs/vis_type_pie.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypePie
title: "visTypePie"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypePie plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie']
---
import visTypePieObj from './vis_type_pie.devdocs.json';
diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx
index e7528fae62bc6..f9106d16c532f 100644
--- a/api_docs/vis_type_table.mdx
+++ b/api_docs/vis_type_table.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTable
title: "visTypeTable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypeTable plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable']
---
import visTypeTableObj from './vis_type_table.devdocs.json';
diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx
index 4e71c01068dd4..599a402469c0f 100644
--- a/api_docs/vis_type_timelion.mdx
+++ b/api_docs/vis_type_timelion.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion
title: "visTypeTimelion"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypeTimelion plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion']
---
import visTypeTimelionObj from './vis_type_timelion.devdocs.json';
diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx
index a339f9f34b3ba..b87b3c9886a1f 100644
--- a/api_docs/vis_type_timeseries.mdx
+++ b/api_docs/vis_type_timeseries.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries
title: "visTypeTimeseries"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypeTimeseries plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries']
---
import visTypeTimeseriesObj from './vis_type_timeseries.devdocs.json';
diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx
index 107bd9d360f81..8aaa38ef75b15 100644
--- a/api_docs/vis_type_vega.mdx
+++ b/api_docs/vis_type_vega.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVega
title: "visTypeVega"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypeVega plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega']
---
import visTypeVegaObj from './vis_type_vega.devdocs.json';
diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx
index 943533028c030..f4cde283ff9d8 100644
--- a/api_docs/vis_type_vislib.mdx
+++ b/api_docs/vis_type_vislib.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVislib
title: "visTypeVislib"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypeVislib plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib']
---
import visTypeVislibObj from './vis_type_vislib.devdocs.json';
diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx
index 3169e73a8f91e..55367e6537d98 100644
--- a/api_docs/vis_type_xy.mdx
+++ b/api_docs/vis_type_xy.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeXy
title: "visTypeXy"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visTypeXy plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy']
---
import visTypeXyObj from './vis_type_xy.devdocs.json';
diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx
index 972ae8f7d3000..c11feff9f4f74 100644
--- a/api_docs/visualizations.mdx
+++ b/api_docs/visualizations.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visualizations
title: "visualizations"
image: https://source.unsplash.com/400x175/?github
description: API docs for the visualizations plugin
-date: 2024-11-13
+date: 2024-11-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations']
---
import visualizationsObj from './visualizations.devdocs.json';
diff --git a/config/serverless.security.yml b/config/serverless.security.yml
index 5057fa193bef4..d7c1a13822ccf 100644
--- a/config/serverless.security.yml
+++ b/config/serverless.security.yml
@@ -92,6 +92,9 @@ xpack.fleet.internal.registry.excludePackages: [
# ML integrations
'dga',
+
+ # Unsupported in serverless
+ 'cloud-defend',
]
# fleet_server package installed to publish agent metrics
xpack.fleet.packages:
diff --git a/config/serverless.yml b/config/serverless.yml
index 75be6151e3bb2..0967df966f61a 100644
--- a/config/serverless.yml
+++ b/config/serverless.yml
@@ -7,6 +7,7 @@ xpack.fleet.internal.disableILMPolicies: true
xpack.fleet.internal.activeAgentsSoftLimit: 25000
xpack.fleet.internal.onlyAllowAgentUpgradeToKnownVersions: true
xpack.fleet.internal.retrySetupOnBoot: true
+xpack.fleet.internal.useMeteringApi: true
## Fine-tune the feature privileges.
xpack.features.overrides:
diff --git a/docs/CHANGELOG.asciidoc b/docs/CHANGELOG.asciidoc
index cd18582a7af6c..85c5bcfbf1127 100644
--- a/docs/CHANGELOG.asciidoc
+++ b/docs/CHANGELOG.asciidoc
@@ -85,6 +85,47 @@ include::upgrade-notes.asciidoc[]
For information about the {kib} 8.16.0 release, review the following information.
+The 8.16.0 release includes the following known issues.
+
+[float]
+[[known-issues-8.16.0]]
+=== Known issues
+
+[discrete]
+[[known-199902]]
+.Stack Monitoring shows "Unable to load page" error
+[%collapsible]
+====
+*Details* +
+The Overview, Nodes, and Logs pages in Stack Monitoring show an "Unable to load page" error. The Stack trace mentions `TypeError: Cannot read properties of undefined (reading 'logsLocator')`.
+
+*Workaround* +
+Disabling the `Set feature visibility > Logs` feature at the Kibana Space settings level will prevent the error from occurring. Please note the `Logs` feature will not be available on those spaces.
+
+It's also possible to set the `Observability > Logs` feature privilege to `None` at the role level. This will hide the `Logs` feature from individual users and prevent the error for these users as well.
+
+For more information, refer to {kibana-issue}199902[#199902].
+====
+
+[discrete]
+[[known-199891-199892]]
+.Onboarding, tutorial of APM and OpenTelemetry and some "Beats Only" integrations shows "Unable to load page" error
+[%collapsible]
+====
+*Details* +
+Tutorials linked from the {kib} home page show an "Unable to load page" error. The Stack trace mentions `The above error occurred in tutorial_TutorialUi`.
+
+*Workaround* +
+The APM / OpenTelemetry tutorials represented a shortcut to quickly add important parameters to the configuration files.
+It is still possible to obtain the same parameters following the tutorials in the APM documentation.
+
+More information can be found in the {observability-guide}/apm-collect-application-data.html[APM documentation] and the {observability-guide}/get-started-with-fleet-apm-server.html[Fleet documentation].
+
+For information about how to create APM API keys, please check the {observability-guide}/apm-api-key.html#apm-create-an-api-key[API key documentation].
+
+For more information, refer to {kibana-issue}199891[#199891] and {kibana-issue}199892[#199892].
+====
+
[float]
[[deprecations-8.16.0]]
=== Deprecations
@@ -114,9 +155,22 @@ The Observability AI Assistant specific advanced setting for Logs index patterns
//*Impact* +
//!!TODO!!
====
-
-
+[float]
+[[breaking-changes-8.16.0]]
+=== Breaking changes
+
+Breaking changes can prevent your application from optimal operation and performance.
+Before you upgrade to 8.16.0, review the breaking changes, then mitigate the impact to your application.
+
+[discrete]
+.Updated request processing during shutdown.
+[%collapsible]
+====
+*Details* +
+During shutdown, {kib} now waits for all the ongoing requests to complete according to the `server.shutdownTimeout` setting. During that period, the incoming socket is closed and any new incoming requests are rejected. Before this update, new incoming requests received a response with the status code 503 and body `{"message": "Kibana is shutting down and not accepting new incoming requests"}`. For more information, refer to {kibana-pull}180986[#180986].
+====
+
[float]
[[features-8.16.0]]
=== Features
diff --git a/docs/developer/advanced/legacy-url-aliases.asciidoc b/docs/developer/advanced/legacy-url-aliases.asciidoc
index 3e441dd582123..a92902d674a15 100644
--- a/docs/developer/advanced/legacy-url-aliases.asciidoc
+++ b/docs/developer/advanced/legacy-url-aliases.asciidoc
@@ -13,11 +13,20 @@ type are *globally unique across all spaces*.
{kib} creates a special entity called a **legacy URL alias** for each saved object that requires a new ID. This legacy URL alias allows
{kib} to preserve any deep link URLs that exist for these objects.
-[[legacy-url-aliases-example]]
-=== Example
+There are two cases where a legacy URL alias will get generated.
+
+1. During migration, when an object's namespace type is being converted from the single-namespace type to a multi-namespace type. If
+the object resides in a non-default space, it gets a new ID and a legacy URL alias is generated.
-Consider the following scenario:
+2. During copy/import of saved objects, when any object requires a new ID **and the compatibilityMode option is enabled** (see the
+<> API and https://github.com/elastic/kibana/pull/149021[PR #149021]
+for more information).
+
+[[legacy-url-aliases-example]]
+=== Examples
+Consider the following scenarios:
+==== Migration scenario
You have {kib} 7.16, and you create a new dashboard.The ID of this dashboard is "123". You create a new space called "Bill's space" and
<> your dashboard to the other space. Now you have two different dashboards that can be accessed
at the following URLs:
@@ -33,6 +42,19 @@ If you use your bookmark to access that dashboard using its old URL, {kib} detec
ID. If you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a message indicating that the dashboard
has a new URL, and you're automatically redirected to `http://localhost:5601/s/bills-space/app/dashboards#/view/456`.
+==== Copy scenario (weak links)
+You have a data view and two dashboards in the default space, but you would also like to have them in another space. One of the dashboards
+includes a Markdown visualization with a link to the other dashboard - a so-called **weak link**. This is a weak link because the ID of the
+referenced object is not added to the object's references array, and therefore there is no explicit relationship between the objects.
+
+If you were to use the <> API to create new copies of these assets in another
+space **without the `compatibilityMode` option set to true**, the Markdown link would be broken. The copied objects created in the target
+space receive a new ID, and the weak link in the Markdown visualization would point to the ID of the source object from the originating space.
+
+By setting `compatibilityMode` to true when using the copy API, legacy aliases will be generated for any objects that require a new ID. This
+allows the weak link to the second dashboard to be resolved. Though a dashboard with the ID from the weak link will not be found, a legacy
+alias with this source ID will have been generated, and it will contain a target ID of the new local copy of the dashboard.
+
[[legacy-url-aliases-handling-errors]]
=== Handling errors
diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
index 71ab26400f496..ea31863576115 100644
--- a/docs/developer/plugin-list.asciidoc
+++ b/docs/developer/plugin-list.asciidoc
@@ -690,6 +690,10 @@ the infrastructure monitoring use-case within Kibana.
using the CURL scripts in the scripts folder.
+|{kib-repo}blob/{branch}/x-pack/plugins/ai_infra/llm_tasks/README.md[llmTasks]
+|This plugin contains various LLM tasks.
+
+
|{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/logs_data_access/README.md[logsDataAccess]
|Exposes services to access logs data.
@@ -767,6 +771,10 @@ Elastic.
|This plugin helps users learn how to use the Painless scripting language.
+|{kib-repo}blob/{branch}/x-pack/plugins/ai_infra/product_doc_base/README.md[productDocBase]
+|This plugin contains the product documentation base service.
+
+
|{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/profiling/README.md[profiling]
|Universal Profiling provides fleet-wide, whole-system, continuous profiling with zero instrumentation. Get a comprehensive understanding of what lines of code are consuming compute resources throughout your entire fleet by visualizing your data in Kibana using the flamegraph, stacktraces, and top functions views.
diff --git a/docs/setup/upgrade/rollback-migration.asciidoc b/docs/setup/upgrade/rollback-migration.asciidoc
index ced12455ff845..6e90cd6836a39 100644
--- a/docs/setup/upgrade/rollback-migration.asciidoc
+++ b/docs/setup/upgrade/rollback-migration.asciidoc
@@ -20,7 +20,7 @@ To roll back after a failed upgrade migration, you must also roll back the {kib}
. To make sure no {kib} instances are performing an upgrade migration, shut down all {kib} instances.
. {ref}/snapshots-restore-snapshot.html[Restore] the `kibana` feature state from a snapshot taken before the failed {kib} upgrade. The following {es} request will only restore the {kib} feature state
+
-[source,sh]
+[source,console]
--------------------------------------------
POST _snapshot/my_repository/my_snapshot_2099.05.06/_restore
{
diff --git a/docs/upgrade-notes.asciidoc b/docs/upgrade-notes.asciidoc
index a0c2d6c1afccb..4d4208b2253f7 100644
--- a/docs/upgrade-notes.asciidoc
+++ b/docs/upgrade-notes.asciidoc
@@ -49,6 +49,32 @@ For Elastic Security release information, refer to {security-guide}/release-note
[float]
==== Kibana APIs
+[discrete]
+[[breaking-199656]]
+.Removed all security v1 endpoints (9.0.0)
+[%collapsible]
+====
+*Details* +
+All `v1` Kibana security HTTP endpoints have been removed.
+
+`GET /api/security/v1/logout` has been replaced by `GET /api/security/logout`
+`GET /api/security/v1/oidc/implicit` has been replaced by `GET /api/security/oidc/implicit`
+`GET /api/security/v1/oidc` has been replaced by GET `/api/security/oidc/callback`
+`POST /api/security/v1/oidc` has been replaced by POST `/api/security/oidc/initiate_login`
+`POST /api/security/v1/saml` has been replaced by POST `/api/security/saml/callback`
+`GET /api/security/v1/me` has been removed with no replacement.
+
+For more information, refer to {kibana-pull}199656[#199656].
+
+*Impact* +
+Any HTTP API calls to the `v1` Kibana security endpoints will fail with a 404 status code starting from version 9.0.0.
+Third party OIDC and SAML identity providers configured with `v1` endpoints will no longer work.
+
+*Action* +
+Update any OIDC and SAML identity providers to reference the corresponding replacement endpoint listed above.
+Remove references to the `/api/security/v1/me` endpoint from any automations, applications, tooling, and scripts.
+====
+
[discrete]
[[breaking-193792]]
.Access to all internal APIs is blocked (9.0.0)
@@ -434,6 +460,15 @@ The endpoint is now split into two separate endpoints:
// General settings
+[discrete]
+[[breaking-180986]]
+.[General settings] Updated request processing during shutdown. (8.16)
+[%collapsible]
+====
+*Details* +
+During shutdown, {kib} now waits for all the ongoing requests to complete according to the `server.shutdownTimeout` setting. During that period, the incoming socket is closed and any new incoming requests are rejected. Before this update, new incoming requests received a response with the status code 503 and body `{"message": "Kibana is shutting down and not accepting new incoming requests"}`. For more information, refer to {kibana-pull}180986[#180986].
+====
+
[discrete]
[[breaking-111535]]
.[General settings] Removed `CONFIG_PATH` and `DATA_PATH` environment variables. (8.0)
@@ -805,18 +840,6 @@ The legacy audit logger has been removed. For more information, refer to {kibana
Audit logs will be written to the default location in the new ECS format. To change the output file, filter events, and more, use the <>.
====
-[discrete]
-[[breaking-47929]]
-.[Security] Removed `/api/security/v1/saml` route. (8.0)
-[%collapsible]
-====
-*Details* +
-The `/api/security/v1/saml` route has been removed and is reflected in the kibana.yml `server.xsrf.whitelist` setting, {es}, and the Identity Provider SAML settings. For more information, refer to {kibana-pull}47929[#47929]
-
-*Impact* +
-Use the `/api/security/saml/callback` route, or wait to upgrade to 8.0.0-alpha2 when the `/api/security/saml/callback` route breaking change is reverted.
-====
-
[discrete]
[[breaking-41700]]
.[Security] Legacy browsers rejected by default. (8.0)
diff --git a/docs/user/security/audit-logging.asciidoc b/docs/user/security/audit-logging.asciidoc
index 1ac40bcc7764a..ef12f4303c1b4 100644
--- a/docs/user/security/audit-logging.asciidoc
+++ b/docs/user/security/audit-logging.asciidoc
@@ -148,6 +148,9 @@ Refer to the corresponding {es} logs for potential write errors.
| `success` | Creating trained model.
| `failure` | Failed to create trained model.
+.1+| `product_documentation_create`
+| `unknown` | User requested to install the product documentation for use in AI Assistants.
+
3+a|
====== Type: change
@@ -334,6 +337,9 @@ Refer to the corresponding {es} logs for potential write errors.
| `success` | Updating trained model deployment.
| `failure` | Failed to update trained model deployment.
+.1+| `product_documentation_update`
+| `unknown` | User requested to update the product documentation for use in AI Assistants.
+
3+a|
====== Type: deletion
@@ -425,6 +431,9 @@ Refer to the corresponding {es} logs for potential write errors.
| `success` | Deleting trained model.
| `failure` | Failed to delete trained model.
+.1+| `product_documentation_delete`
+| `unknown` | User requested to delete the product documentation for use in AI Assistants.
+
3+a|
====== Type: access
diff --git a/docs/user/security/fips-140-2.asciidoc b/docs/user/security/fips-140-2.asciidoc
index 2b4b195f38b05..eada7bcc59cc7 100644
--- a/docs/user/security/fips-140-2.asciidoc
+++ b/docs/user/security/fips-140-2.asciidoc
@@ -29,7 +29,7 @@ For {kib}, adherence to FIPS 140-2 is ensured by:
==== Configuring {kib} for FIPS 140-2
-Apart from setting `xpack.security.experimental.fipsMode.enabled` to `true` in your {kib} config, a number of security related
+Apart from setting `xpack.security.fipsMode.enabled` to `true` in your {kib} config, a number of security related
settings need to be reviewed and configured in order to run {kib} successfully in a FIPS 140-2 compliant Node.js
environment.
@@ -56,8 +56,3 @@ As an example, avoid PKCS#12 specific settings such as:
* `server.ssl.truststore.path`
* `elasticsearch.ssl.keystore.path`
* `elasticsearch.ssl.truststore.path`
-
-===== Limitations
-
-Configuring {kib} to run in FIPS mode is still considered to be experimental. Not all features are guaranteed to
-function as expected.
diff --git a/examples/content_management_examples/public/examples/finder/finder_app.tsx b/examples/content_management_examples/public/examples/finder/finder_app.tsx
index 99ec949fac7d1..b8aaa6fe5f34b 100644
--- a/examples/content_management_examples/public/examples/finder/finder_app.tsx
+++ b/examples/content_management_examples/public/examples/finder/finder_app.tsx
@@ -23,6 +23,7 @@ export const FinderApp = (props: {
"output/kibana.serverless.tmp1.yaml"
@npx bump-cli overlay "output/kibana.serverless.tmp1.yaml" "overlays/alerting.overlays.yaml" > "output/kibana.serverless.tmp2.yaml"
@npx bump-cli overlay "output/kibana.serverless.tmp2.yaml" "overlays/connectors.overlays.yaml" > "output/kibana.serverless.tmp3.yaml"
@@ -48,24 +53,20 @@ api-docs-overlay: ## Run spectral API docs linter on kibana.serverless.yaml
@npx bump-cli overlay "output/kibana.tmp1.yaml" "overlays/alerting.overlays.yaml" > "output/kibana.tmp2.yaml"
@npx bump-cli overlay "output/kibana.tmp2.yaml" "overlays/connectors.overlays.yaml" > "output/kibana.tmp3.yaml"
@npx bump-cli overlay "output/kibana.tmp3.yaml" "overlays/kibana.overlays.shared.yaml" > "output/kibana.tmp4.yaml"
- @npx @redocly/cli bundle output/kibana.serverless.tmp4.yaml --ext yaml -o output/kibana.serverless.new.yaml
- @npx @redocly/cli bundle output/kibana.tmp4.yaml --ext yaml -o output/kibana.new.yaml
+ @npx @redocly/cli bundle output/kibana.serverless.tmp4.yaml --ext yaml -o output/kibana.serverless.yaml
+ @npx @redocly/cli bundle output/kibana.tmp4.yaml --ext yaml -o output/kibana.yaml
rm output/kibana.tmp*.yaml
rm output/kibana.serverless.tmp*.yaml
.PHONY: api-docs-preview
api-docs-preview: ## Generate a preview for kibana.yaml and kibana.serverless.yaml
+ @echo "Rendering stateful docs preview..."
@npx bump-cli preview "output/kibana.yaml"
+ @echo "Rendering serverless docs preview..."
@npx bump-cli preview "output/kibana.serverless.yaml"
-.PHONY: api-docs-overlay-preview
-api-docs-overlay-preview: ## Generate a preview for kibana.new.yaml and kibana.serverless.new.yaml
- @npx bump-cli preview "output/kibana.new.yaml"
- @npx bump-cli preview "output/kibana.serverless.new.yaml"
-
help: ## Display help
@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
#------------- --------------
-.DEFAULT_GOAL := help
-
+.DEFAULT_GOAL := help
\ No newline at end of file
diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
index 2b64330a1937a..4b35e4d9c78fc 100644
--- a/oas_docs/output/kibana.serverless.yaml
+++ b/oas_docs/output/kibana.serverless.yaml
@@ -2,61 +2,36 @@ openapi: 3.0.3
info:
contact:
name: Kibana Team
- description: >
+ description: |
**Technical preview**
-
- This functionality is in technical preview and may be changed or removed in
- a future release.
-
- Elastic will work to fix any issues, but features in technical preview are
- not subject to the support SLA of official GA features.
-
+ This functionality is in technical preview and may be changed or removed in a future release.
+ Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
The Kibana REST APIs for Elastic serverless enable you to manage resources
-
such as connectors, data views, and saved objects. The API calls are
-
stateless. Each request that you make happens in isolation from other calls
-
and must include all of the necessary information for Kibana to fulfill the
-
request. API requests return JSON output, which is a format that is
-
machine-readable and works well for automation.
-
To interact with Kibana APIs, use the following operations:
-
- GET: Fetches the information.
-
- POST: Adds new information.
-
- PUT: Updates the existing information.
-
- DELETE: Removes the information.
-
You can prepend any Kibana API endpoint with `kbn:` and run the request in
-
**Dev Tools → Console**. For example:
-
```
-
GET kbn:/api/data_views
-
```
-
## Documentation source and versions
-
- This documentation is derived from the `main` branch of the
- [kibana](https://github.com/elastic/kibana) repository.
-
- It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0
- International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
+ This documentation is derived from the `main` branch of the [kibana](https://github.com/elastic/kibana) repository.
+ It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
title: Kibana Serverless APIs
version: 1.0.2
x-doc-license:
@@ -64,23 +39,118 @@ info:
url: https://creativecommons.org/licenses/by-nc-nd/4.0/
x-feedbackLink:
label: Feedback
- url: >-
- https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
+ url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- - url: http://{kibana_host}:{port}
- variables:
- kibana_host:
- default: localhost
- port:
- default: '5601'
- - url: http://localhost:5622
- url: https://{kibana_url}
variables:
kibana_url:
default: localhost:5601
- - url: /
- - description: local
- url: http://localhost:5601
+security:
+ - apiKeyAuth: []
+tags:
+ - name: alerting
+ description: |
+ Alerting enables you to define rules, which detect complex conditions within your data. When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule. Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
+ externalDocs:
+ description: Alerting documentation
+ url: https://www.elastic.co/docs/current/serverless/rules
+ x-displayName: Alerting
+ - description: |
+ Adjust APM agent configuration without need to redeploy your application.
+ name: APM agent configuration
+ - description: |
+ Configure APM agent keys to authorize requests from APM agents to the APM Server.
+ name: APM agent keys
+ - description: |
+ Annotate visualizations in the APM app with significant events. Annotations enable you to easily see how events are impacting the performance of your applications.
+ name: APM annotations
+ - description: Create APM fleet server schema.
+ name: APM server schema
+ - description: Configure APM source maps.
+ name: APM sourcemaps
+ - name: connectors
+ description: |
+ Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems. Alerting rules can use connectors to run actions when rule conditions are met.
+ externalDocs:
+ description: Connector documentation
+ url: https://www.elastic.co/docs/current/serverless/action-connectors
+ x-displayName: Connectors
+ - name: Data streams
+ - description: Data view APIs enable you to manage data views, formerly known as Kibana index patterns.
+ name: data views
+ x-displayName: Data views
+ - name: Elastic Agent actions
+ - name: Elastic Agent binary download sources
+ - name: Elastic Agent policies
+ - name: Elastic Agent status
+ - name: Elastic Agents
+ - name: Elastic Package Manager (EPM)
+ - name: Fleet enrollment API keys
+ - name: Fleet internals
+ - name: Fleet outputs
+ - name: Fleet package policies
+ - name: Fleet proxies
+ - name: Fleet Server hosts
+ - name: Fleet service tokens
+ - name: Fleet uninstall tokens
+ - name: Message Signing Service
+ - description: Machine learning
+ name: ml
+ x-displayName: Machine learning
+ - name: roles
+ x-displayName: Roles
+ description: Manage the roles that grant Elasticsearch and Kibana privileges.
+ externalDocs:
+ description: Kibana role management
+ url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
+ - description: |
+ Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
+
+ To manage a specific type of saved object, use the corresponding APIs.
+ For example, use:
+
+ [Data views](../group/endpoint-data-views)
+
+ Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.
+ name: saved objects
+ x-displayName: Saved objects
+ - description: Manage and interact with Security Assistant resources.
+ name: Security AI Assistant API
+ x-displayName: Security AI assistant
+ - description: You can create rules that automatically turn events and external alerts sent to Elastic Security into detection alerts. These alerts are displayed on the Detections page.
+ name: Security Detections API
+ x-displayName: Security detections
+ - description: Endpoint Exceptions API allows you to manage detection rule endpoint exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met.
+ name: Security Endpoint Exceptions API
+ x-displayName: Security endpoint exceptions
+ - description: Interact with and manage endpoints running the Elastic Defend integration.
+ name: Security Endpoint Management API
+ x-displayName: Security endpoint management
+ - description: ''
+ name: Security Entity Analytics API
+ x-displayName: Security entity analytics
+ - description: Exceptions API allows you to manage detection rule exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met.
+ name: Security Exceptions API
+ x-displayName: Security exceptions
+ - description: Lists API allows you to manage lists of keywords, IPs or IP ranges items.
+ name: Security Lists API
+ x-displayName: Security lists
+ - description: Run live queries, manage packs and saved queries.
+ name: Security Osquery API
+ x-displayName: Security Osquery
+ - description: You can create Timelines and Timeline templates via the API, as well as import new Timelines from an ndjson file.
+ name: Security Timeline API
+ x-displayName: Security timeline
+ - description: SLO APIs enable you to define, manage and track service-level objectives
+ name: slo
+ x-displayName: Service level objectives
+ - name: spaces
+ x-displayName: Spaces
+ description: Manage your Kibana spaces.
+ - name: system
+ x-displayName: System
+ description: |
+ Get information about the system status, resource usage, and installed plugins.
paths:
/api/actions/connector_types:
get:
@@ -95,18 +165,24 @@ paths:
enum:
- '2023-10-31'
type: string
- - description: >-
- A filter to limit the retrieved connector types to those that
- support a specific feature (such as alerting or cases).
+ - description: A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).
in: query
name: feature_id
required: false
schema:
type: string
- responses: {}
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getConnectorTypesServerlessResponse:
+ $ref: '#/components/examples/get_connector_types_generativeai_response'
summary: Get connector types
tags:
- connectors
+ x-beta: true
/api/actions/connector/{id}:
delete:
description: 'WARNING: When you delete a connector, it cannot be recovered.'
@@ -139,6 +215,7 @@ paths:
summary: Delete a connector
tags:
- connectors
+ x-beta: true
get:
operationId: get-actions-connector-id
parameters:
@@ -180,15 +257,10 @@ paths:
description: Indicates whether the connector is missing secrets.
type: boolean
is_preconfigured:
- description: >-
- Indicates whether the connector is preconfigured. If true,
- the `config` and `is_missing_secrets` properties are
- omitted from the response.
+ description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. '
type: boolean
is_system_action:
- description: >-
- Indicates whether the connector is used for system
- actions.
+ description: Indicates whether the connector is used for system actions.
type: boolean
name:
description: ' The name of the rule.'
@@ -200,10 +272,14 @@ paths:
- is_preconfigured
- is_deprecated
- is_system_action
+ examples:
+ getConnectorResponse:
+ $ref: '#/components/examples/get_connector_response'
description: Indicates a successful call.
summary: Get connector information
tags:
- connectors
+ x-beta: true
post:
operationId: post-actions-connector-id
parameters:
@@ -225,7 +301,7 @@ paths:
- description: An identifier for the connector.
in: path
name: id
- required: false
+ required: true
schema:
type: string
requestBody:
@@ -235,23 +311,77 @@ paths:
additionalProperties: false
type: object
properties:
- config:
- additionalProperties: {}
- default: {}
- type: object
connector_type_id:
description: The type of connector.
type: string
name:
description: The display name for the connector.
type: string
+ config:
+ additionalProperties: {}
+ default: {}
+ description: The connector configuration details.
+ oneOf:
+ - $ref: '#/components/schemas/bedrock_config'
+ - $ref: '#/components/schemas/crowdstrike_config'
+ - $ref: '#/components/schemas/d3security_config'
+ - $ref: '#/components/schemas/email_config'
+ - $ref: '#/components/schemas/gemini_config'
+ - $ref: '#/components/schemas/resilient_config'
+ - $ref: '#/components/schemas/index_config'
+ - $ref: '#/components/schemas/jira_config'
+ - $ref: '#/components/schemas/genai_azure_config'
+ - $ref: '#/components/schemas/genai_openai_config'
+ - $ref: '#/components/schemas/opsgenie_config'
+ - $ref: '#/components/schemas/pagerduty_config'
+ - $ref: '#/components/schemas/sentinelone_config'
+ - $ref: '#/components/schemas/servicenow_config'
+ - $ref: '#/components/schemas/servicenow_itom_config'
+ - $ref: '#/components/schemas/slack_api_config'
+ - $ref: '#/components/schemas/swimlane_config'
+ - $ref: '#/components/schemas/thehive_config'
+ - $ref: '#/components/schemas/tines_config'
+ - $ref: '#/components/schemas/torq_config'
+ - $ref: '#/components/schemas/webhook_config'
+ - $ref: '#/components/schemas/cases_webhook_config'
+ - $ref: '#/components/schemas/xmatters_config'
secrets:
additionalProperties: {}
default: {}
- type: object
+ oneOf:
+ - $ref: '#/components/schemas/bedrock_secrets'
+ - $ref: '#/components/schemas/crowdstrike_secrets'
+ - $ref: '#/components/schemas/d3security_secrets'
+ - $ref: '#/components/schemas/email_secrets'
+ - $ref: '#/components/schemas/gemini_secrets'
+ - $ref: '#/components/schemas/resilient_secrets'
+ - $ref: '#/components/schemas/jira_secrets'
+ - $ref: '#/components/schemas/teams_secrets'
+ - $ref: '#/components/schemas/genai_secrets'
+ - $ref: '#/components/schemas/opsgenie_secrets'
+ - $ref: '#/components/schemas/pagerduty_secrets'
+ - $ref: '#/components/schemas/sentinelone_secrets'
+ - $ref: '#/components/schemas/servicenow_secrets'
+ - $ref: '#/components/schemas/slack_api_secrets'
+ - $ref: '#/components/schemas/swimlane_secrets'
+ - $ref: '#/components/schemas/thehive_secrets'
+ - $ref: '#/components/schemas/tines_secrets'
+ - $ref: '#/components/schemas/torq_secrets'
+ - $ref: '#/components/schemas/webhook_secrets'
+ - $ref: '#/components/schemas/cases_webhook_secrets'
+ - $ref: '#/components/schemas/xmatters_secrets'
required:
- name
- connector_type_id
+ examples:
+ createEmailConnectorRequest:
+ $ref: '#/components/examples/create_email_connector_request'
+ createIndexConnectorRequest:
+ $ref: '#/components/examples/create_index_connector_request'
+ createWebhookConnectorRequest:
+ $ref: '#/components/examples/create_webhook_connector_request'
+ createXmattersConnectorRequest:
+ $ref: '#/components/examples/create_xmatters_connector_request'
responses:
'200':
content:
@@ -276,15 +406,10 @@ paths:
description: Indicates whether the connector is missing secrets.
type: boolean
is_preconfigured:
- description: >-
- Indicates whether the connector is preconfigured. If true,
- the `config` and `is_missing_secrets` properties are
- omitted from the response.
+ description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. '
type: boolean
is_system_action:
- description: >-
- Indicates whether the connector is used for system
- actions.
+ description: Indicates whether the connector is used for system actions.
type: boolean
name:
description: ' The name of the rule.'
@@ -296,10 +421,20 @@ paths:
- is_preconfigured
- is_deprecated
- is_system_action
+ examples:
+ createEmailConnectorResponse:
+ $ref: '#/components/examples/create_email_connector_response'
+ createIndexConnectorResponse:
+ $ref: '#/components/examples/create_index_connector_response'
+ createWebhookConnectorResponse:
+ $ref: '#/components/examples/create_webhook_connector_response'
+ createXmattersConnectorResponse:
+ $ref: '#/components/examples/get_connector_response'
description: Indicates a successful call.
summary: Create a connector
tags:
- connectors
+ x-beta: true
put:
operationId: put-actions-connector-id
parameters:
@@ -331,19 +466,67 @@ paths:
additionalProperties: false
type: object
properties:
- config:
- additionalProperties: {}
- default: {}
- type: object
name:
description: The display name for the connector.
type: string
+ config:
+ additionalProperties: {}
+ default: {}
+ description: The connector configuration details.
+ oneOf:
+ - $ref: '#/components/schemas/bedrock_config'
+ - $ref: '#/components/schemas/crowdstrike_config'
+ - $ref: '#/components/schemas/d3security_config'
+ - $ref: '#/components/schemas/email_config'
+ - $ref: '#/components/schemas/gemini_config'
+ - $ref: '#/components/schemas/resilient_config'
+ - $ref: '#/components/schemas/index_config'
+ - $ref: '#/components/schemas/jira_config'
+ - $ref: '#/components/schemas/genai_azure_config'
+ - $ref: '#/components/schemas/genai_openai_config'
+ - $ref: '#/components/schemas/opsgenie_config'
+ - $ref: '#/components/schemas/pagerduty_config'
+ - $ref: '#/components/schemas/sentinelone_config'
+ - $ref: '#/components/schemas/servicenow_config'
+ - $ref: '#/components/schemas/servicenow_itom_config'
+ - $ref: '#/components/schemas/slack_api_config'
+ - $ref: '#/components/schemas/swimlane_config'
+ - $ref: '#/components/schemas/thehive_config'
+ - $ref: '#/components/schemas/tines_config'
+ - $ref: '#/components/schemas/torq_config'
+ - $ref: '#/components/schemas/webhook_config'
+ - $ref: '#/components/schemas/cases_webhook_config'
+ - $ref: '#/components/schemas/xmatters_config'
secrets:
additionalProperties: {}
default: {}
- type: object
+ oneOf:
+ - $ref: '#/components/schemas/bedrock_secrets'
+ - $ref: '#/components/schemas/crowdstrike_secrets'
+ - $ref: '#/components/schemas/d3security_secrets'
+ - $ref: '#/components/schemas/email_secrets'
+ - $ref: '#/components/schemas/gemini_secrets'
+ - $ref: '#/components/schemas/resilient_secrets'
+ - $ref: '#/components/schemas/jira_secrets'
+ - $ref: '#/components/schemas/teams_secrets'
+ - $ref: '#/components/schemas/genai_secrets'
+ - $ref: '#/components/schemas/opsgenie_secrets'
+ - $ref: '#/components/schemas/pagerduty_secrets'
+ - $ref: '#/components/schemas/sentinelone_secrets'
+ - $ref: '#/components/schemas/servicenow_secrets'
+ - $ref: '#/components/schemas/slack_api_secrets'
+ - $ref: '#/components/schemas/swimlane_secrets'
+ - $ref: '#/components/schemas/thehive_secrets'
+ - $ref: '#/components/schemas/tines_secrets'
+ - $ref: '#/components/schemas/torq_secrets'
+ - $ref: '#/components/schemas/webhook_secrets'
+ - $ref: '#/components/schemas/cases_webhook_secrets'
+ - $ref: '#/components/schemas/xmatters_secrets'
required:
- name
+ examples:
+ updateIndexConnectorRequest:
+ $ref: '#/components/examples/update_index_connector_request'
responses:
'200':
content:
@@ -368,15 +551,10 @@ paths:
description: Indicates whether the connector is missing secrets.
type: boolean
is_preconfigured:
- description: >-
- Indicates whether the connector is preconfigured. If true,
- the `config` and `is_missing_secrets` properties are
- omitted from the response.
+ description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. '
type: boolean
is_system_action:
- description: >-
- Indicates whether the connector is used for system
- actions.
+ description: Indicates whether the connector is used for system actions.
type: boolean
name:
description: ' The name of the rule.'
@@ -392,11 +570,10 @@ paths:
summary: Update a connector
tags:
- connectors
+ x-beta: true
/api/actions/connector/{id}/_execute:
post:
- description: >-
- You can use this API to test an action that involves interaction with
- Kibana services or integrations with third-party systems.
+ description: You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.
operationId: post-actions-connector-id-execute
parameters:
- description: The version of the API to use
@@ -429,9 +606,40 @@ paths:
properties:
params:
additionalProperties: {}
- type: object
+ oneOf:
+ - $ref: '#/components/schemas/run_acknowledge_resolve_pagerduty'
+ - $ref: '#/components/schemas/run_documents'
+ - $ref: '#/components/schemas/run_message_email'
+ - $ref: '#/components/schemas/run_message_serverlog'
+ - $ref: '#/components/schemas/run_message_slack'
+ - $ref: '#/components/schemas/run_trigger_pagerduty'
+ - $ref: '#/components/schemas/run_addevent'
+ - $ref: '#/components/schemas/run_closealert'
+ - $ref: '#/components/schemas/run_closeincident'
+ - $ref: '#/components/schemas/run_createalert'
+ - $ref: '#/components/schemas/run_fieldsbyissuetype'
+ - $ref: '#/components/schemas/run_getchoices'
+ - $ref: '#/components/schemas/run_getfields'
+ - $ref: '#/components/schemas/run_getincident'
+ - $ref: '#/components/schemas/run_issue'
+ - $ref: '#/components/schemas/run_issues'
+ - $ref: '#/components/schemas/run_issuetypes'
+ - $ref: '#/components/schemas/run_postmessage'
+ - $ref: '#/components/schemas/run_pushtoservice'
+ - $ref: '#/components/schemas/run_validchannelid'
required:
- params
+ examples:
+ runIndexConnectorRequest:
+ $ref: '#/components/examples/run_index_connector_request'
+ runJiraConnectorRequest:
+ $ref: '#/components/examples/run_jira_connector_request'
+ runServerLogConnectorRequest:
+ $ref: '#/components/examples/run_servicenow_itom_connector_request'
+ runSlackConnectorRequest:
+ $ref: '#/components/examples/run_slack_api_connector_request'
+ runSwimlaneConnectorRequest:
+ $ref: '#/components/examples/run_swimlane_connector_request'
responses:
'200':
content:
@@ -456,15 +664,10 @@ paths:
description: Indicates whether the connector is missing secrets.
type: boolean
is_preconfigured:
- description: >-
- Indicates whether the connector is preconfigured. If true,
- the `config` and `is_missing_secrets` properties are
- omitted from the response.
+ description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. '
type: boolean
is_system_action:
- description: >-
- Indicates whether the connector is used for system
- actions.
+ description: Indicates whether the connector is used for system actions.
type: boolean
name:
description: ' The name of the rule.'
@@ -476,10 +679,24 @@ paths:
- is_preconfigured
- is_deprecated
- is_system_action
+ examples:
+ runIndexConnectorResponse:
+ $ref: '#/components/examples/run_index_connector_response'
+ runJiraConnectorResponse:
+ $ref: '#/components/examples/run_jira_connector_response'
+ runServerLogConnectorResponse:
+ $ref: '#/components/examples/run_server_log_connector_response'
+ runServiceNowITOMConnectorResponse:
+ $ref: '#/components/examples/run_servicenow_itom_connector_response'
+ runSlackConnectorResponse:
+ $ref: '#/components/examples/run_slack_api_connector_response'
+ runSwimlaneConnectorResponse:
+ $ref: '#/components/examples/run_swimlane_connector_response'
description: Indicates a successful call.
summary: Run a connector
tags:
- connectors
+ x-beta: true
/api/actions/connectors:
get:
operationId: get-actions-connectors
@@ -492,10 +709,18 @@ paths:
enum:
- '2023-10-31'
type: string
- responses: {}
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getConnectorsResponse:
+ $ref: '#/components/examples/get_connectors_response'
summary: Get all connectors
tags:
- connectors
+ x-beta: true
/api/alerting/rule/{id}:
delete:
operationId: delete-alerting-rule-id
@@ -533,6 +758,7 @@ paths:
summary: Delete a rule
tags:
- alerting
+ x-beta: true
get:
operationId: get-alerting-rule-id
parameters:
@@ -565,9 +791,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
query:
@@ -575,15 +799,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL) as defined in
- the `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -593,9 +812,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -612,9 +829,7 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
@@ -624,12 +839,7 @@ paths:
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the
- days of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -646,55 +856,30 @@ paths:
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work
- but lack built-in daylight savings time
- support and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
- hours
- timezone
connector_type_id:
- description: >-
- The type of connector. This property appears in
- responses but cannot be set in requests.
+ description: The type of connector. This property appears in responses but cannot be set in requests.
type: string
frequency:
additionalProperties: false
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -704,18 +889,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often
- an alert generates repeated actions. It is
- specified in seconds, minutes, hours, or days
- and is applicable only if 'notify_when' is set
- to 'onThrottleInterval'. NOTE: You cannot
- specify the throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if ''notify_when'' is set to ''onThrottleInterval''. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -723,30 +897,20 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
type: string
params:
additionalProperties: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
type: boolean
uuid:
- description: >-
- A universally unique identifier (UUID) for the
- action.
+ description: A universally unique identifier (UUID) for the action.
type: string
required:
- id
@@ -760,36 +924,24 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
api_key_created_by_user:
- description: >-
- Indicates whether the API key that is associated with the
- rule was created by the user.
+ description: Indicates whether the API key that is associated with the rule was created by the user.
nullable: true
type: boolean
api_key_owner:
- description: >-
- The owner of the API key that is associated with the rule
- and used to run background tasks.
+ description: The owner of the API key that is associated with the rule and used to run background tasks.
nullable: true
type: string
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
created_at:
description: The date and time that the rule was created.
@@ -799,9 +951,7 @@ paths:
nullable: true
type: string
enabled:
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
execution_status:
additionalProperties: false
@@ -868,14 +1018,17 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -915,9 +1068,7 @@ paths:
nullable: true
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could be
- succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
@@ -967,9 +1118,7 @@ paths:
properties:
calculated_metrics:
additionalProperties: false
- description: >-
- Calculation of different percentiles and success
- ratio.
+ description: Calculation of different percentiles and success ratio.
type: object
properties:
p50:
@@ -992,18 +1141,14 @@ paths:
description: Duration of the rule run.
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could
- be succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
- failed
type: string
success:
- description: >-
- Indicates whether the rule run was
- successful.
+ description: Indicates whether the rule run was successful.
type: boolean
timestamp:
description: Time of rule run.
@@ -1028,29 +1173,19 @@ paths:
nullable: true
type: number
total_alerts_created:
- description: >-
- Total number of alerts created during last
- rule run.
+ description: Total number of alerts created during last rule run.
nullable: true
type: number
total_alerts_detected:
- description: >-
- Total number of alerts detected during
- last rule run.
+ description: Total number of alerts detected during last rule run.
nullable: true
type: number
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during
- last rule run in milliseconds.
+ description: Total time spent indexing documents during last rule run in milliseconds.
nullable: true
type: number
total_search_duration_ms:
- description: >-
- Total time spent performing Elasticsearch
- searches as measured by Kibana; includes
- network latency and time spent serializing
- or deserializing the request and response.
+ description: Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
nullable: true
type: number
timestamp:
@@ -1081,19 +1216,7 @@ paths:
nullable: true
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -1119,9 +1242,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours,
- or days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -1157,9 +1278,7 @@ paths:
type: array
bymonth:
items:
- description: >-
- Indicates months of the year that this rule
- should recur.
+ description: Indicates months of the year that this rule should recur.
type: number
nullable: true
type: array
@@ -1177,12 +1296,7 @@ paths:
type: array
bysetpos:
items:
- description: >-
- A positive or negative integer affecting the
- nth day of the month. For example, -2 combined
- with `byweekday` of FR is 2nd to last Friday
- of the month. It is recommended to not set
- this manually and just use `byweekday`.
+ description: A positive or negative integer affecting the nth day of the month. For example, -2 combined with `byweekday` of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use `byweekday`.
type: number
nullable: true
type: array
@@ -1191,13 +1305,7 @@ paths:
anyOf:
- type: string
- type: number
- description: >-
- Indicates the days of the week to recur or
- else nth-day-of-month strings. For example,
- "+2TU" second Tuesday of month, "-1FR" last
- Friday of the month, which are internally
- converted to a `byweekday/bysetpos`
- combination.
+ description: Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a `byweekday/bysetpos` combination.
nullable: true
type: array
byweekno:
@@ -1208,26 +1316,18 @@ paths:
type: array
byyearday:
items:
- description: >-
- Indicates the days of the year that this rule
- should recur.
+ description: Indicates the days of the year that this rule should recur.
type: number
nullable: true
type: array
count:
- description: >-
- Number of times the rule should recur until it
- stops.
+ description: Number of times the rule should recur until it stops.
type: number
dtstart:
- description: >-
- Rule start date in Coordinated Universal Time
- (UTC).
+ description: Rule start date in Coordinated Universal Time (UTC).
type: string
freq:
- description: >-
- Indicates frequency of the rule. Options are
- YEARLY, MONTHLY, WEEKLY, DAILY.
+ description: Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
enum:
- 0
- 1
@@ -1238,10 +1338,7 @@ paths:
- 6
type: integer
interval:
- description: >-
- Indicates the interval of frequency. For
- example, 1 and YEARLY is every 1 year, 2 and
- WEEKLY is every 2 weeks.
+ description: Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
type: number
tzid:
description: Indicates timezone abbreviation.
@@ -1279,23 +1376,14 @@ paths:
type: array
throttle:
deprecated: true
- description: >-
- Deprecated in 8.13.0. 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.
+ description: 'Deprecated in 8.13.0. 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.'
nullable: true
type: string
updated_at:
description: The date and time that the rule was updated most recently.
type: string
updated_by:
- description: >-
- The identifier for the user that updated this rule most
- recently.
+ description: The identifier for the user that updated this rule most recently.
nullable: true
type: string
view_in_app_relative_url:
@@ -1331,6 +1419,7 @@ paths:
summary: Get rule details
tags:
- alerting
+ x-beta: true
post:
operationId: post-alerting-rule-id
parameters:
@@ -1349,12 +1438,10 @@ paths:
schema:
example: 'true'
type: string
- - description: >-
- The identifier for the rule. If it is omitted, an ID is randomly
- generated.
+ - description: The identifier for the rule. If it is omitted, an ID is randomly generated.
in: path
name: id
- required: false
+ required: true
schema:
type: string
requestBody:
@@ -1373,12 +1460,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Conditions that affect whether the action runs. If you
- specify multiple conditions, all conditions must be
- met for the action to run. For example, if an alert
- occurs within the specified time frame and matches the
- query, the action runs.
+ description: Conditions that affect whether the action runs. If you specify multiple conditions, all conditions must be met for the action to run. For example, if an alert occurs within the specified time frame and matches the query, the action runs.
type: object
properties:
query:
@@ -1386,15 +1468,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query Domain
- Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query Domain
- Specific Language (DSL) as defined in the
- `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -1404,9 +1481,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -1423,27 +1498,18 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
- filters
timeframe:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the days
- of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -1457,32 +1523,20 @@ paths:
type: array
hours:
additionalProperties: false
- description: >-
- Defines the range of time in a day that the
- action can run. If the `start` value is
- `00:00` and the `end` value is `24:00`,
- actions be generated all day.
+ description: Defines the range of time in a day that the action can run. If the `start` value is `00:00` and the `end` value is `24:00`, actions be generated all day.
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work but
- lack built-in daylight savings time support
- and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
@@ -1493,21 +1547,7 @@ paths:
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -1517,17 +1557,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often an
- alert generates repeated actions. It is specified
- in seconds, minutes, hours, or days and is
- applicable only if `notify_when` is set to
- `onThrottleInterval`. NOTE: You cannot specify the
- throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if `notify_when` is set to `onThrottleInterval`. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -1535,12 +1565,7 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
@@ -1548,10 +1573,7 @@ paths:
params:
additionalProperties: {}
default: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
@@ -1564,41 +1586,34 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
enabled:
default: true
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -1606,49 +1621,26 @@ paths:
- look_back_window
- status_change_threshold
name:
- description: >-
- The name of the rule. While this name does not have to be
- unique, a distinctive name can help you identify a rule.
+ description: The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
- onThrottleInterval
nullable: true
type: string
- params:
- additionalProperties: {}
- default: {}
- description: The parameters for the rule.
- type: object
rule_type_id:
description: The rule type identifier.
type: string
schedule:
additionalProperties: false
- description: >-
- The check interval, which specifies how frequently the rule
- conditions are checked.
+ description: The check interval, which specifies how frequently the rule conditions are checked.
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours, or
- days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -1659,20 +1651,44 @@ paths:
type: string
type: array
throttle:
- description: >-
- 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.
+ description: '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.'
nullable: true
type: string
+ params:
+ additionalProperties: {}
+ default: {}
+ description: The parameters for the rule.
+ anyOf:
+ - $ref: '#/components/schemas/params_property_apm_anomaly'
+ - $ref: '#/components/schemas/params_property_apm_error_count'
+ - $ref: '#/components/schemas/params_property_apm_transaction_duration'
+ - $ref: '#/components/schemas/params_property_apm_transaction_error_rate'
+ - $ref: '#/components/schemas/params_es_query_dsl_rule'
+ - $ref: '#/components/schemas/params_es_query_esql_rule'
+ - $ref: '#/components/schemas/params_es_query_kql_rule'
+ - $ref: '#/components/schemas/params_index_threshold_rule'
+ - $ref: '#/components/schemas/params_property_infra_inventory'
+ - $ref: '#/components/schemas/params_property_log_threshold'
+ - $ref: '#/components/schemas/params_property_infra_metric_threshold'
+ - $ref: '#/components/schemas/params_property_slo_burn_rate'
+ - $ref: '#/components/schemas/params_property_synthetics_uptime_tls'
+ - $ref: '#/components/schemas/params_property_synthetics_monitor_status'
required:
- name
- rule_type_id
- consumer
- schedule
+ examples:
+ createEsQueryEsqlRuleRequest:
+ $ref: '#/components/examples/create_es_query_esql_rule_request'
+ createEsQueryRuleRequest:
+ $ref: '#/components/examples/create_es_query_rule_request'
+ createEsQueryKqlRuleRequest:
+ $ref: '#/components/examples/create_es_query_kql_rule_request'
+ createIndexThresholdRuleRequest:
+ $ref: '#/components/examples/create_index_threshold_rule_request'
+ createTrackingContainmentRuleRequest:
+ $ref: '#/components/examples/create_tracking_containment_rule_request'
responses:
'200':
content:
@@ -1688,9 +1704,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
query:
@@ -1698,15 +1712,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL) as defined in
- the `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -1716,9 +1725,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -1735,9 +1742,7 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
@@ -1747,12 +1752,7 @@ paths:
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the
- days of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -1769,55 +1769,30 @@ paths:
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work
- but lack built-in daylight savings time
- support and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
- hours
- timezone
connector_type_id:
- description: >-
- The type of connector. This property appears in
- responses but cannot be set in requests.
+ description: The type of connector. This property appears in responses but cannot be set in requests.
type: string
frequency:
additionalProperties: false
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -1827,18 +1802,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often
- an alert generates repeated actions. It is
- specified in seconds, minutes, hours, or days
- and is applicable only if 'notify_when' is set
- to 'onThrottleInterval'. NOTE: You cannot
- specify the throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if ''notify_when'' is set to ''onThrottleInterval''. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -1846,30 +1810,20 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
type: string
params:
additionalProperties: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
type: boolean
uuid:
- description: >-
- A universally unique identifier (UUID) for the
- action.
+ description: A universally unique identifier (UUID) for the action.
type: string
required:
- id
@@ -1883,36 +1837,24 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
api_key_created_by_user:
- description: >-
- Indicates whether the API key that is associated with the
- rule was created by the user.
+ description: Indicates whether the API key that is associated with the rule was created by the user.
nullable: true
type: boolean
api_key_owner:
- description: >-
- The owner of the API key that is associated with the rule
- and used to run background tasks.
+ description: The owner of the API key that is associated with the rule and used to run background tasks.
nullable: true
type: string
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
created_at:
description: The date and time that the rule was created.
@@ -1922,9 +1864,7 @@ paths:
nullable: true
type: string
enabled:
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
execution_status:
additionalProperties: false
@@ -1991,14 +1931,17 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -2038,9 +1981,7 @@ paths:
nullable: true
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could be
- succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
@@ -2090,9 +2031,7 @@ paths:
properties:
calculated_metrics:
additionalProperties: false
- description: >-
- Calculation of different percentiles and success
- ratio.
+ description: Calculation of different percentiles and success ratio.
type: object
properties:
p50:
@@ -2115,18 +2054,14 @@ paths:
description: Duration of the rule run.
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could
- be succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
- failed
type: string
success:
- description: >-
- Indicates whether the rule run was
- successful.
+ description: Indicates whether the rule run was successful.
type: boolean
timestamp:
description: Time of rule run.
@@ -2151,29 +2086,19 @@ paths:
nullable: true
type: number
total_alerts_created:
- description: >-
- Total number of alerts created during last
- rule run.
+ description: Total number of alerts created during last rule run.
nullable: true
type: number
total_alerts_detected:
- description: >-
- Total number of alerts detected during
- last rule run.
+ description: Total number of alerts detected during last rule run.
nullable: true
type: number
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during
- last rule run in milliseconds.
+ description: Total time spent indexing documents during last rule run in milliseconds.
nullable: true
type: number
total_search_duration_ms:
- description: >-
- Total time spent performing Elasticsearch
- searches as measured by Kibana; includes
- network latency and time spent serializing
- or deserializing the request and response.
+ description: Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
nullable: true
type: number
timestamp:
@@ -2204,19 +2129,7 @@ paths:
nullable: true
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -2242,9 +2155,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours,
- or days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -2280,9 +2191,7 @@ paths:
type: array
bymonth:
items:
- description: >-
- Indicates months of the year that this rule
- should recur.
+ description: Indicates months of the year that this rule should recur.
type: number
nullable: true
type: array
@@ -2300,12 +2209,7 @@ paths:
type: array
bysetpos:
items:
- description: >-
- A positive or negative integer affecting the
- nth day of the month. For example, -2 combined
- with `byweekday` of FR is 2nd to last Friday
- of the month. It is recommended to not set
- this manually and just use `byweekday`.
+ description: A positive or negative integer affecting the nth day of the month. For example, -2 combined with `byweekday` of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use `byweekday`.
type: number
nullable: true
type: array
@@ -2314,13 +2218,7 @@ paths:
anyOf:
- type: string
- type: number
- description: >-
- Indicates the days of the week to recur or
- else nth-day-of-month strings. For example,
- "+2TU" second Tuesday of month, "-1FR" last
- Friday of the month, which are internally
- converted to a `byweekday/bysetpos`
- combination.
+ description: Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a `byweekday/bysetpos` combination.
nullable: true
type: array
byweekno:
@@ -2331,26 +2229,18 @@ paths:
type: array
byyearday:
items:
- description: >-
- Indicates the days of the year that this rule
- should recur.
+ description: Indicates the days of the year that this rule should recur.
type: number
nullable: true
type: array
count:
- description: >-
- Number of times the rule should recur until it
- stops.
+ description: Number of times the rule should recur until it stops.
type: number
dtstart:
- description: >-
- Rule start date in Coordinated Universal Time
- (UTC).
+ description: Rule start date in Coordinated Universal Time (UTC).
type: string
freq:
- description: >-
- Indicates frequency of the rule. Options are
- YEARLY, MONTHLY, WEEKLY, DAILY.
+ description: Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
enum:
- 0
- 1
@@ -2361,10 +2251,7 @@ paths:
- 6
type: integer
interval:
- description: >-
- Indicates the interval of frequency. For
- example, 1 and YEARLY is every 1 year, 2 and
- WEEKLY is every 2 weeks.
+ description: Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
type: number
tzid:
description: Indicates timezone abbreviation.
@@ -2402,23 +2289,14 @@ paths:
type: array
throttle:
deprecated: true
- description: >-
- Deprecated in 8.13.0. 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.
+ description: 'Deprecated in 8.13.0. 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.'
nullable: true
type: string
updated_at:
description: The date and time that the rule was updated most recently.
type: string
updated_by:
- description: >-
- The identifier for the user that updated this rule most
- recently.
+ description: The identifier for the user that updated this rule most recently.
nullable: true
type: string
view_in_app_relative_url:
@@ -2444,6 +2322,17 @@ paths:
- muted_alert_ids
- execution_status
- revision
+ examples:
+ createEsQueryEsqlRuleResponse:
+ $ref: '#/components/examples/create_es_query_esql_rule_response'
+ createEsQueryRuleResponse:
+ $ref: '#/components/examples/create_es_query_rule_response'
+ createEsQueryKqlRuleResponse:
+ $ref: '#/components/examples/create_es_query_kql_rule_response'
+ createIndexThresholdRuleResponse:
+ $ref: '#/components/examples/create_index_threshold_rule_response'
+ createTrackingContainmentRuleResponse:
+ $ref: '#/components/examples/create_tracking_containment_rule_response'
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
@@ -2454,6 +2343,7 @@ paths:
summary: Create a rule
tags:
- alerting
+ x-beta: true
put:
operationId: put-alerting-rule-id
parameters:
@@ -2501,15 +2391,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query Domain
- Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query Domain
- Specific Language (DSL) as defined in the
- `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -2519,9 +2404,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -2538,27 +2421,18 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
- filters
timeframe:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the days
- of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -2572,32 +2446,20 @@ paths:
type: array
hours:
additionalProperties: false
- description: >-
- Defines the range of time in a day that the
- action can run. If the `start` value is
- `00:00` and the `end` value is `24:00`,
- actions be generated all day.
+ description: Defines the range of time in a day that the action can run. If the `start` value is `00:00` and the `end` value is `24:00`, actions be generated all day.
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work but
- lack built-in daylight savings time support
- and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
@@ -2608,21 +2470,7 @@ paths:
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -2632,17 +2480,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often an
- alert generates repeated actions. It is specified
- in seconds, minutes, hours, or days and is
- applicable only if `notify_when` is set to
- `onThrottleInterval`. NOTE: You cannot specify the
- throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if `notify_when` is set to `onThrottleInterval`. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -2650,12 +2488,7 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
@@ -2663,10 +2496,7 @@ paths:
params:
additionalProperties: {}
default: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
@@ -2679,28 +2509,27 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -2708,24 +2537,10 @@ paths:
- look_back_window
- status_change_threshold
name:
- description: >-
- The name of the rule. While this name does not have to be
- unique, a distinctive name can help you identify a rule.
+ description: The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -2742,9 +2557,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours, or
- days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -2755,18 +2568,15 @@ paths:
type: string
type: array
throttle:
- description: >-
- 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.
+ description: '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.'
nullable: true
type: string
required:
- name
- schedule
+ examples:
+ updateRuleRequest:
+ $ref: '#/components/examples/update_rule_request'
responses:
'200':
content:
@@ -2782,9 +2592,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
query:
@@ -2792,15 +2600,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL) as defined in
- the `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -2810,9 +2613,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -2829,9 +2630,7 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
@@ -2841,12 +2640,7 @@ paths:
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the
- days of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -2863,55 +2657,30 @@ paths:
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work
- but lack built-in daylight savings time
- support and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
- hours
- timezone
connector_type_id:
- description: >-
- The type of connector. This property appears in
- responses but cannot be set in requests.
+ description: The type of connector. This property appears in responses but cannot be set in requests.
type: string
frequency:
additionalProperties: false
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -2921,18 +2690,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often
- an alert generates repeated actions. It is
- specified in seconds, minutes, hours, or days
- and is applicable only if 'notify_when' is set
- to 'onThrottleInterval'. NOTE: You cannot
- specify the throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if ''notify_when'' is set to ''onThrottleInterval''. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -2940,30 +2698,20 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
type: string
params:
additionalProperties: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
type: boolean
uuid:
- description: >-
- A universally unique identifier (UUID) for the
- action.
+ description: A universally unique identifier (UUID) for the action.
type: string
required:
- id
@@ -2977,36 +2725,24 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
api_key_created_by_user:
- description: >-
- Indicates whether the API key that is associated with the
- rule was created by the user.
+ description: Indicates whether the API key that is associated with the rule was created by the user.
nullable: true
type: boolean
api_key_owner:
- description: >-
- The owner of the API key that is associated with the rule
- and used to run background tasks.
+ description: The owner of the API key that is associated with the rule and used to run background tasks.
nullable: true
type: string
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
created_at:
description: The date and time that the rule was created.
@@ -3016,9 +2752,7 @@ paths:
nullable: true
type: string
enabled:
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
execution_status:
additionalProperties: false
@@ -3085,14 +2819,17 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -3132,9 +2869,7 @@ paths:
nullable: true
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could be
- succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
@@ -3184,9 +2919,7 @@ paths:
properties:
calculated_metrics:
additionalProperties: false
- description: >-
- Calculation of different percentiles and success
- ratio.
+ description: Calculation of different percentiles and success ratio.
type: object
properties:
p50:
@@ -3209,18 +2942,14 @@ paths:
description: Duration of the rule run.
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could
- be succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
- failed
type: string
success:
- description: >-
- Indicates whether the rule run was
- successful.
+ description: Indicates whether the rule run was successful.
type: boolean
timestamp:
description: Time of rule run.
@@ -3245,29 +2974,19 @@ paths:
nullable: true
type: number
total_alerts_created:
- description: >-
- Total number of alerts created during last
- rule run.
+ description: Total number of alerts created during last rule run.
nullable: true
type: number
total_alerts_detected:
- description: >-
- Total number of alerts detected during
- last rule run.
+ description: Total number of alerts detected during last rule run.
nullable: true
type: number
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during
- last rule run in milliseconds.
+ description: Total time spent indexing documents during last rule run in milliseconds.
nullable: true
type: number
total_search_duration_ms:
- description: >-
- Total time spent performing Elasticsearch
- searches as measured by Kibana; includes
- network latency and time spent serializing
- or deserializing the request and response.
+ description: Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
nullable: true
type: number
timestamp:
@@ -3298,19 +3017,7 @@ paths:
nullable: true
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -3336,9 +3043,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours,
- or days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -3374,9 +3079,7 @@ paths:
type: array
bymonth:
items:
- description: >-
- Indicates months of the year that this rule
- should recur.
+ description: Indicates months of the year that this rule should recur.
type: number
nullable: true
type: array
@@ -3394,12 +3097,7 @@ paths:
type: array
bysetpos:
items:
- description: >-
- A positive or negative integer affecting the
- nth day of the month. For example, -2 combined
- with `byweekday` of FR is 2nd to last Friday
- of the month. It is recommended to not set
- this manually and just use `byweekday`.
+ description: A positive or negative integer affecting the nth day of the month. For example, -2 combined with `byweekday` of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use `byweekday`.
type: number
nullable: true
type: array
@@ -3408,13 +3106,7 @@ paths:
anyOf:
- type: string
- type: number
- description: >-
- Indicates the days of the week to recur or
- else nth-day-of-month strings. For example,
- "+2TU" second Tuesday of month, "-1FR" last
- Friday of the month, which are internally
- converted to a `byweekday/bysetpos`
- combination.
+ description: Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a `byweekday/bysetpos` combination.
nullable: true
type: array
byweekno:
@@ -3425,26 +3117,18 @@ paths:
type: array
byyearday:
items:
- description: >-
- Indicates the days of the year that this rule
- should recur.
+ description: Indicates the days of the year that this rule should recur.
type: number
nullable: true
type: array
count:
- description: >-
- Number of times the rule should recur until it
- stops.
+ description: Number of times the rule should recur until it stops.
type: number
dtstart:
- description: >-
- Rule start date in Coordinated Universal Time
- (UTC).
+ description: Rule start date in Coordinated Universal Time (UTC).
type: string
freq:
- description: >-
- Indicates frequency of the rule. Options are
- YEARLY, MONTHLY, WEEKLY, DAILY.
+ description: Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
enum:
- 0
- 1
@@ -3455,10 +3139,7 @@ paths:
- 6
type: integer
interval:
- description: >-
- Indicates the interval of frequency. For
- example, 1 and YEARLY is every 1 year, 2 and
- WEEKLY is every 2 weeks.
+ description: Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
type: number
tzid:
description: Indicates timezone abbreviation.
@@ -3496,23 +3177,14 @@ paths:
type: array
throttle:
deprecated: true
- description: >-
- Deprecated in 8.13.0. 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.
+ description: 'Deprecated in 8.13.0. 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.'
nullable: true
type: string
updated_at:
description: The date and time that the rule was updated most recently.
type: string
updated_by:
- description: >-
- The identifier for the user that updated this rule most
- recently.
+ description: The identifier for the user that updated this rule most recently.
nullable: true
type: string
view_in_app_relative_url:
@@ -3538,6 +3210,9 @@ paths:
- muted_alert_ids
- execution_status
- revision
+ examples:
+ updateRuleResponse:
+ $ref: '#/components/examples/update_rule_response'
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
@@ -3550,6 +3225,7 @@ paths:
summary: Update a rule
tags:
- alerting
+ x-beta: true
/api/alerting/rule/{id}/_disable:
post:
operationId: post-alerting-rule-id-disable
@@ -3599,6 +3275,7 @@ paths:
summary: Disable a rule
tags:
- alerting
+ x-beta: true
/api/alerting/rule/{id}/_enable:
post:
operationId: post-alerting-rule-id-enable
@@ -3636,6 +3313,7 @@ paths:
summary: Enable a rule
tags:
- alerting
+ x-beta: true
/api/alerting/rule/{id}/_mute_all:
post:
operationId: post-alerting-rule-id-mute-all
@@ -3673,6 +3351,7 @@ paths:
summary: Mute all alerts
tags:
- alerting
+ x-beta: true
/api/alerting/rule/{id}/_unmute_all:
post:
operationId: post-alerting-rule-id-unmute-all
@@ -3710,6 +3389,7 @@ paths:
summary: Unmute all alerts
tags:
- alerting
+ x-beta: true
/api/alerting/rule/{id}/_update_api_key:
post:
operationId: post-alerting-rule-id-update-api-key
@@ -3749,6 +3429,7 @@ paths:
summary: Update the API key for a rule
tags:
- alerting
+ x-beta: true
/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute:
post:
operationId: post-alerting-rule-rule-id-alert-alert-id-mute
@@ -3792,6 +3473,7 @@ paths:
summary: Mute an alert
tags:
- alerting
+ x-beta: true
/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute:
post:
operationId: post-alerting-rule-rule-id-alert-alert-id-unmute
@@ -3835,6 +3517,7 @@ paths:
summary: Unmute an alert
tags:
- alerting
+ x-beta: true
/api/alerting/rules/_find:
get:
operationId: get-alerting-rules-find
@@ -3863,9 +3546,7 @@ paths:
default: 1
minimum: 1
type: number
- - description: >-
- An Elasticsearch simple_query_string query that filters the objects
- in the response.
+ - description: An Elasticsearch simple_query_string query that filters the objects in the response.
in: query
name: search
required: false
@@ -3891,9 +3572,7 @@ paths:
type: string
type: array
- type: string
- - description: >-
- Determines which field is used to sort the results. The field must
- exist in the `attributes` key of the response.
+ - description: Determines which field is used to sort the results. The field must exist in the `attributes` key of the response.
in: query
name: sort_field
required: false
@@ -3908,9 +3587,7 @@ paths:
- asc
- desc
type: string
- - description: >-
- Filters the rules that have a relation with the reference objects
- with a specific type and identifier.
+ - description: Filters the rules that have a relation with the reference objects with a specific type and identifier.
in: query
name: has_reference
required: false
@@ -3934,12 +3611,7 @@ paths:
description: The fields to return in the `attributes` key of the response.
type: string
type: array
- - description: >-
- 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`.
+ - description: '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`.'
in: query
name: filter
required: false
@@ -3968,9 +3640,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
query:
@@ -3978,15 +3648,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL) as defined in
- the `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -3996,9 +3661,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -4015,9 +3678,7 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
@@ -4027,12 +3688,7 @@ paths:
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the
- days of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -4049,55 +3705,30 @@ paths:
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work
- but lack built-in daylight savings time
- support and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
- hours
- timezone
connector_type_id:
- description: >-
- The type of connector. This property appears in
- responses but cannot be set in requests.
+ description: The type of connector. This property appears in responses but cannot be set in requests.
type: string
frequency:
additionalProperties: false
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -4107,18 +3738,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often
- an alert generates repeated actions. It is
- specified in seconds, minutes, hours, or days
- and is applicable only if 'notify_when' is set
- to 'onThrottleInterval'. NOTE: You cannot
- specify the throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if ''notify_when'' is set to ''onThrottleInterval''. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -4126,30 +3746,20 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
type: string
params:
additionalProperties: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
type: boolean
uuid:
- description: >-
- A universally unique identifier (UUID) for the
- action.
+ description: A universally unique identifier (UUID) for the action.
type: string
required:
- id
@@ -4163,36 +3773,24 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
api_key_created_by_user:
- description: >-
- Indicates whether the API key that is associated with the
- rule was created by the user.
+ description: Indicates whether the API key that is associated with the rule was created by the user.
nullable: true
type: boolean
api_key_owner:
- description: >-
- The owner of the API key that is associated with the rule
- and used to run background tasks.
+ description: The owner of the API key that is associated with the rule and used to run background tasks.
nullable: true
type: string
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
created_at:
description: The date and time that the rule was created.
@@ -4202,9 +3800,7 @@ paths:
nullable: true
type: string
enabled:
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
execution_status:
additionalProperties: false
@@ -4271,14 +3867,17 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -4318,9 +3917,7 @@ paths:
nullable: true
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could be
- succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
@@ -4370,9 +3967,7 @@ paths:
properties:
calculated_metrics:
additionalProperties: false
- description: >-
- Calculation of different percentiles and success
- ratio.
+ description: Calculation of different percentiles and success ratio.
type: object
properties:
p50:
@@ -4395,18 +3990,14 @@ paths:
description: Duration of the rule run.
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could
- be succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
- failed
type: string
success:
- description: >-
- Indicates whether the rule run was
- successful.
+ description: Indicates whether the rule run was successful.
type: boolean
timestamp:
description: Time of rule run.
@@ -4431,29 +4022,19 @@ paths:
nullable: true
type: number
total_alerts_created:
- description: >-
- Total number of alerts created during last
- rule run.
+ description: Total number of alerts created during last rule run.
nullable: true
type: number
total_alerts_detected:
- description: >-
- Total number of alerts detected during
- last rule run.
+ description: Total number of alerts detected during last rule run.
nullable: true
type: number
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during
- last rule run in milliseconds.
+ description: Total time spent indexing documents during last rule run in milliseconds.
nullable: true
type: number
total_search_duration_ms:
- description: >-
- Total time spent performing Elasticsearch
- searches as measured by Kibana; includes
- network latency and time spent serializing
- or deserializing the request and response.
+ description: Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
nullable: true
type: number
timestamp:
@@ -4484,19 +4065,7 @@ paths:
nullable: true
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -4522,9 +4091,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours,
- or days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -4560,9 +4127,7 @@ paths:
type: array
bymonth:
items:
- description: >-
- Indicates months of the year that this rule
- should recur.
+ description: Indicates months of the year that this rule should recur.
type: number
nullable: true
type: array
@@ -4580,12 +4145,7 @@ paths:
type: array
bysetpos:
items:
- description: >-
- A positive or negative integer affecting the
- nth day of the month. For example, -2 combined
- with `byweekday` of FR is 2nd to last Friday
- of the month. It is recommended to not set
- this manually and just use `byweekday`.
+ description: A positive or negative integer affecting the nth day of the month. For example, -2 combined with `byweekday` of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use `byweekday`.
type: number
nullable: true
type: array
@@ -4594,13 +4154,7 @@ paths:
anyOf:
- type: string
- type: number
- description: >-
- Indicates the days of the week to recur or
- else nth-day-of-month strings. For example,
- "+2TU" second Tuesday of month, "-1FR" last
- Friday of the month, which are internally
- converted to a `byweekday/bysetpos`
- combination.
+ description: Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a `byweekday/bysetpos` combination.
nullable: true
type: array
byweekno:
@@ -4611,26 +4165,18 @@ paths:
type: array
byyearday:
items:
- description: >-
- Indicates the days of the year that this rule
- should recur.
+ description: Indicates the days of the year that this rule should recur.
type: number
nullable: true
type: array
count:
- description: >-
- Number of times the rule should recur until it
- stops.
+ description: Number of times the rule should recur until it stops.
type: number
dtstart:
- description: >-
- Rule start date in Coordinated Universal Time
- (UTC).
+ description: Rule start date in Coordinated Universal Time (UTC).
type: string
freq:
- description: >-
- Indicates frequency of the rule. Options are
- YEARLY, MONTHLY, WEEKLY, DAILY.
+ description: Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
enum:
- 0
- 1
@@ -4641,10 +4187,7 @@ paths:
- 6
type: integer
interval:
- description: >-
- Indicates the interval of frequency. For
- example, 1 and YEARLY is every 1 year, 2 and
- WEEKLY is every 2 weeks.
+ description: Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
type: number
tzid:
description: Indicates timezone abbreviation.
@@ -4682,23 +4225,14 @@ paths:
type: array
throttle:
deprecated: true
- description: >-
- Deprecated in 8.13.0. 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.
+ description: 'Deprecated in 8.13.0. 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.'
nullable: true
type: string
updated_at:
description: The date and time that the rule was updated most recently.
type: string
updated_by:
- description: >-
- The identifier for the user that updated this rule most
- recently.
+ description: The identifier for the user that updated this rule most recently.
nullable: true
type: string
view_in_app_relative_url:
@@ -4724,6 +4258,11 @@ paths:
- muted_alert_ids
- execution_status
- revision
+ examples:
+ findRulesResponse:
+ $ref: '#/components/examples/find_rules_response'
+ findConditionalActionRulesResponse:
+ $ref: '#/components/examples/find_rules_response_conditional_action'
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
@@ -4732,6 +4271,7 @@ paths:
summary: Get information about rules
tags:
- alerting
+ x-beta: true
/api/apm/agent_keys:
post:
description: Create a new agent key for APM.
@@ -4779,6 +4319,7 @@ paths:
summary: Create an APM agent key
tags:
- APM agent keys
+ x-beta: true
/api/apm/fleet/apm_server_schema:
post:
operationId: saveApmServerSchema
@@ -4833,6 +4374,7 @@ paths:
summary: Save APM server schema
tags:
- APM server schema
+ x-beta: true
/api/apm/services/{serviceName}/annotation:
post:
description: Create a new annotation for a specific service.
@@ -4886,6 +4428,7 @@ paths:
summary: Create a service annotation
tags:
- APM annotations
+ x-beta: true
/api/apm/services/{serviceName}/annotation/search:
get:
description: Search for annotations related to a specific service.
@@ -4944,6 +4487,7 @@ paths:
summary: Search for annotations
tags:
- APM annotations
+ x-beta: true
/api/apm/settings/agent-configuration:
delete:
operationId: deleteAgentConfiguration
@@ -4961,8 +4505,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/APM_UI_delete_agent_configurations_response
+ $ref: '#/components/schemas/APM_UI_delete_agent_configurations_response'
description: Successful response
'400':
content:
@@ -4991,6 +4534,7 @@ paths:
summary: Delete agent configuration
tags:
- APM agent configuration
+ x-beta: true
get:
operationId: getAgentConfigurations
parameters:
@@ -5023,6 +4567,7 @@ paths:
summary: Get a list of agent configurations
tags:
- APM agent configuration
+ x-beta: true
put:
operationId: createUpdateAgentConfiguration
parameters:
@@ -5074,6 +4619,7 @@ paths:
summary: Create or update agent configuration
tags:
- APM agent configuration
+ x-beta: true
/api/apm/settings/agent-configuration/agent_name:
get:
description: Retrieve `agentName` for a service.
@@ -5115,6 +4661,7 @@ paths:
summary: Get agent name for service
tags:
- APM agent configuration
+ x-beta: true
/api/apm/settings/agent-configuration/environments:
get:
operationId: getEnvironmentsForService
@@ -5153,11 +4700,11 @@ paths:
summary: Get environments for service
tags:
- APM agent configuration
+ x-beta: true
/api/apm/settings/agent-configuration/search:
post:
- description: >
- This endpoint allows to search for single agent configuration and update
- 'applied_by_agent' field.
+ description: |
+ This endpoint allows to search for single agent configuration and update 'applied_by_agent' field.
operationId: searchSingleConfiguration
parameters:
- $ref: '#/components/parameters/APM_UI_elastic_api_version'
@@ -5173,8 +4720,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/APM_UI_search_agent_configuration_response
+ $ref: '#/components/schemas/APM_UI_search_agent_configuration_response'
description: Successful response
'400':
content:
@@ -5197,6 +4743,7 @@ paths:
summary: Lookup single agent configuration
tags:
- APM agent configuration
+ x-beta: true
/api/apm/settings/agent-configuration/view:
get:
operationId: getSingleAgentConfiguration
@@ -5219,8 +4766,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/APM_UI_single_agent_configuration_response
+ $ref: '#/components/schemas/APM_UI_single_agent_configuration_response'
description: Successful response
'400':
content:
@@ -5243,6 +4789,7 @@ paths:
summary: Get single agent configuration
tags:
- APM agent configuration
+ x-beta: true
/api/apm/sourcemaps:
get:
description: Returns an array of Fleet artifacts, including source map uploads.
@@ -5293,6 +4840,7 @@ paths:
summary: Get source maps
tags:
- APM sourcemaps
+ x-beta: true
post:
description: Upload a source map for a specific service and version.
operationId: uploadSourceMap
@@ -5345,6 +4893,7 @@ paths:
summary: Upload source map
tags:
- APM sourcemaps
+ x-beta: true
/api/apm/sourcemaps/{id}:
delete:
description: Delete a previously uploaded source map.
@@ -5399,6 +4948,7 @@ paths:
summary: Delete source map
tags:
- APM sourcemaps
+ x-beta: true
/api/asset_criticality:
delete:
description: Delete the asset criticality record for a specific entity.
@@ -5433,13 +4983,10 @@ paths:
type: object
properties:
deleted:
- description: >-
- True if the record was deleted or false if the record did
- not exist.
+ description: True if the record was deleted or false if the record did not exist.
type: boolean
record:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord'
description: The deleted record if it existed.
required:
- deleted
@@ -5449,6 +4996,7 @@ paths:
summary: Delete an asset criticality record
tags:
- Security Entity Analytics API
+ x-beta: true
get:
description: Get the asset criticality record for a specific entity.
operationId: GetAssetCriticalityRecord
@@ -5471,8 +5019,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord'
description: Successful response
'400':
description: Invalid request
@@ -5481,28 +5028,23 @@ paths:
summary: Get an asset criticality record
tags:
- Security Entity Analytics API
+ x-beta: true
post:
- description: >
+ description: |
Create or update an asset criticality record for a specific entity.
-
- If a record already exists for the specified entity, that record is
- overwritten with the specified value. If a record doesn't exist for the
- specified entity, a new record is created.
+ If a record already exists for the specified entity, that record is overwritten with the specified value. If a record doesn't exist for the specified entity, a new record is created.
operationId: CreateAssetCriticalityRecord
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
allOf:
- - $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord
+ - $ref: '#/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord'
- type: object
properties:
refresh:
- description: >-
- If 'wait_for' the request will wait for the index
- refresh.
+ description: If 'wait_for' the request will wait for the index refresh.
enum:
- wait_for
type: string
@@ -5512,24 +5054,20 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord'
description: Successful response
'400':
description: Invalid request
summary: Upsert an asset criticality record
tags:
- Security Entity Analytics API
+ x-beta: true
/api/asset_criticality/bulk:
post:
- description: >
+ description: |
Bulk upsert up to 1000 asset criticality records.
-
- If asset criticality records already exist for the specified entities,
- those records are overwritten with the specified values. If asset
- criticality records don't exist for the specified entities, new records
- are created.
+ If asset criticality records already exist for the specified entities, those records are overwritten with the specified values. If asset criticality records don't exist for the specified entities, new records are created.
operationId: BulkUpsertAssetCriticalityRecords
requestBody:
content:
@@ -5547,8 +5085,7 @@ paths:
properties:
records:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord'
maxItems: 1000
minItems: 1
type: array
@@ -5571,12 +5108,10 @@ paths:
properties:
errors:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityBulkUploadErrorItem
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityBulkUploadErrorItem'
type: array
stats:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityBulkUploadStats
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityBulkUploadStats'
required:
- errors
- stats
@@ -5586,6 +5121,7 @@ paths:
summary: Bulk upsert asset criticality records
tags:
- Security Entity Analytics API
+ x-beta: true
/api/asset_criticality/list:
get:
description: List asset criticality records, paging, sorting and filtering as needed.
@@ -5648,8 +5184,7 @@ paths:
type: integer
records:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord'
type: array
total:
minimum: 0
@@ -5663,6 +5198,7 @@ paths:
summary: List asset criticality records
tags:
- Security Entity Analytics API
+ x-beta: true
/api/data_views:
get:
operationId: getAllDataViewsDefault
@@ -5703,6 +5239,7 @@ paths:
summary: Get all data views
tags:
- data views
+ x-beta: true
/api/data_views/data_view:
post:
operationId: createDataViewDefaultw
@@ -5733,6 +5270,7 @@ paths:
summary: Create a data view
tags:
- data views
+ x-beta: true
/api/data_views/data_view/{viewId}:
delete:
description: |
@@ -5753,6 +5291,7 @@ paths:
summary: Delete a data view
tags:
- data views
+ x-beta: true
get:
operationId: getDataViewDefault
parameters:
@@ -5776,6 +5315,7 @@ paths:
summary: Get a data view
tags:
- data views
+ x-beta: true
post:
operationId: updateDataViewDefault
parameters:
@@ -5806,11 +5346,11 @@ paths:
summary: Update a data view
tags:
- data views
+ x-beta: true
/api/data_views/data_view/{viewId}/fields:
post:
- description: >
- Update fields presentation metadata such as count, customLabel,
- customDescription, and format.
+ description: |
+ Update fields presentation metadata such as count, customLabel, customDescription, and format.
operationId: updateFieldsMetadataDefault
parameters:
- $ref: '#/components/parameters/Data_views_kbn_xsrf'
@@ -5849,6 +5389,7 @@ paths:
summary: Update data view fields metadata
tags:
- data views
+ x-beta: true
/api/data_views/data_view/{viewId}/runtime_field:
post:
operationId: createRuntimeFieldDefault
@@ -5886,6 +5427,7 @@ paths:
summary: Create a runtime field
tags:
- data views
+ x-beta: true
put:
operationId: createUpdateRuntimeFieldDefault
parameters:
@@ -5941,6 +5483,7 @@ paths:
summary: Create or update a runtime field
tags:
- data views
+ x-beta: true
/api/data_views/data_view/{viewId}/runtime_field/{fieldName}:
delete:
operationId: deleteRuntimeFieldDefault
@@ -5959,6 +5502,7 @@ paths:
summary: Delete a runtime field from a data view
tags:
- data views
+ x-beta: true
get:
operationId: getRuntimeFieldDefault
parameters:
@@ -5990,6 +5534,7 @@ paths:
summary: Get a runtime field
tags:
- data views
+ x-beta: true
post:
operationId: updateRuntimeFieldDefault
parameters:
@@ -6028,6 +5573,7 @@ paths:
summary: Update a runtime field
tags:
- data views
+ x-beta: true
/api/data_views/default:
get:
operationId: getDefaultDataViewDefault
@@ -6037,8 +5583,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
examples:
getDefaultDataViewResponse:
- $ref: >-
- #/components/examples/Data_views_get_default_data_view_response
+ $ref: '#/components/examples/Data_views_get_default_data_view_response'
schema:
type: object
properties:
@@ -6054,6 +5599,7 @@ paths:
summary: Get the default data view
tags:
- data views
+ x-beta: true
post:
operationId: setDefaultDatailViewDefault
parameters:
@@ -6068,10 +5614,8 @@ paths:
type: object
properties:
data_view_id:
- description: >
- The data view identifier. NOTE: The API does not validate
- whether it is a valid identifier. Use `null` to unset the
- default data view.
+ description: |
+ The data view identifier. NOTE: The API does not validate whether it is a valid identifier. Use `null` to unset the default data view.
nullable: true
type: string
force:
@@ -6100,12 +5644,11 @@ paths:
summary: Set the default data view
tags:
- data views
+ x-beta: true
/api/data_views/swap_references:
post:
- description: >
- Changes saved object references from one data view identifier to
- another. WARNING: Misuse can break large numbers of saved objects!
- Practicing with a backup is recommended.
+ description: |
+ Changes saved object references from one data view identifier to another. WARNING: Misuse can break large numbers of saved objects! Practicing with a backup is recommended.
operationId: swapDataViewsDefault
parameters:
- $ref: '#/components/parameters/Data_views_kbn_xsrf'
@@ -6147,11 +5690,11 @@ paths:
summary: Swap saved object references
tags:
- data views
+ x-beta: true
/api/data_views/swap_references/_preview:
post:
- description: >
- Preview the impact of swapping saved object references from one data
- view identifier to another.
+ description: |
+ Preview the impact of swapping saved object references from one data view identifier to another.
operationId: previewSwapDataViewsDefault
parameters:
- $ref: '#/components/parameters/Data_views_kbn_xsrf'
@@ -6160,8 +5703,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
examples:
previewSwapDataViewRequest:
- $ref: >-
- #/components/examples/Data_views_preview_swap_data_view_request
+ $ref: '#/components/examples/Data_views_preview_swap_data_view_request'
schema:
$ref: '#/components/schemas/Data_views_swap_data_view_request_object'
required: true
@@ -6187,16 +5729,13 @@ paths:
summary: Preview a saved object reference swap
tags:
- data views
+ x-beta: true
/api/detection_engine/privileges:
get:
- description: >
- Retrieves whether or not the user is authenticated, and the user's
- Kibana
-
+ description: |
+ Retrieves whether or not the user is authenticated, and the user's Kibana
space and index privileges, which determine if the user can create an
-
index for the Elastic Security alerts generated by
-
detection engine rules.
operationId: ReadPrivileges
responses:
@@ -6218,8 +5757,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -6230,7 +5768,7 @@ paths:
summary: Returns user privileges for the Kibana space
tags:
- Security Detections API
- - Privileges API
+ x-beta: true
/api/detection_engine/rules:
delete:
description: Delete a detection rule using the `rule_id` or `id` field.
@@ -6258,7 +5796,7 @@ paths:
summary: Delete a detection rule
tags:
- Security Detections API
- - Rules API
+ x-beta: true
get:
description: Retrieve a detection rule using the `rule_id` or `id` field.
operationId: ReadRule
@@ -6285,11 +5823,9 @@ paths:
summary: Retrieve a detection rule
tags:
- Security Detections API
- - Rules API
+ x-beta: true
patch:
- description: >-
- Update specific fields of an existing detection rule using the `rule_id`
- or `id` field.
+ description: Update specific fields of an existing detection rule using the `rule_id` or `id` field.
operationId: PatchRule
requestBody:
content:
@@ -6307,7 +5843,7 @@ paths:
summary: Patch a detection rule
tags:
- Security Detections API
- - Rules API
+ x-beta: true
post:
description: Create a new detection rule.
operationId: CreateRule
@@ -6327,14 +5863,11 @@ paths:
summary: Create a detection rule
tags:
- Security Detections API
- - Rules API
+ x-beta: true
put:
- description: >
- Update a detection rule using the `rule_id` or `id` field. The original
- rule is replaced, and all unspecified fields are deleted.
-
+ description: |
+ Update a detection rule using the `rule_id` or `id` field. The original rule is replaced, and all unspecified fields are deleted.
> info
-
> You cannot modify the `id` or `rule_id` values.
operationId: UpdateRule
requestBody:
@@ -6353,13 +5886,10 @@ paths:
summary: Update a detection rule
tags:
- Security Detections API
- - Rules API
+ x-beta: true
/api/detection_engine/rules/_bulk_action:
post:
- description: >-
- Apply a bulk action, such as bulk edit, duplicate, or delete, to
- multiple detection rules. The bulk action is applied to all rules that
- match the query or to the rules listed by their IDs.
+ description: Apply a bulk action, such as bulk edit, duplicate, or delete, to multiple detection rules. The bulk action is applied to all rules that match the query or to the rules listed by their IDs.
operationId: PerformRulesBulkAction
parameters:
- description: Enables dry run mode for the request call.
@@ -6374,14 +5904,11 @@ paths:
schema:
oneOf:
- $ref: '#/components/schemas/Security_Detections_API_BulkDeleteRules'
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkDisableRules
+ - $ref: '#/components/schemas/Security_Detections_API_BulkDisableRules'
- $ref: '#/components/schemas/Security_Detections_API_BulkEnableRules'
- $ref: '#/components/schemas/Security_Detections_API_BulkExportRules'
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkDuplicateRules
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkManualRuleRun
+ - $ref: '#/components/schemas/Security_Detections_API_BulkDuplicateRules'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkManualRuleRun'
- $ref: '#/components/schemas/Security_Detections_API_BulkEditRules'
responses:
'200':
@@ -6389,27 +5916,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkEditActionResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkExportActionResponse
+ - $ref: '#/components/schemas/Security_Detections_API_BulkEditActionResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkExportActionResponse'
description: OK
summary: Apply a bulk action to detection rules
tags:
- Security Detections API
- - Bulk API
+ x-beta: true
/api/detection_engine/rules/_export:
post:
- description: >
- Export detection rules to an `.ndjson` file. The following configuration
- items are also included in the `.ndjson` file:
-
+ description: |
+ Export detection rules to an `.ndjson` file. The following configuration items are also included in the `.ndjson` file:
- Actions
-
- Exception lists
-
> info
-
> You cannot export prebuilt rules.
operationId: ExportRules
parameters:
@@ -6435,15 +5955,12 @@ paths:
type: object
properties:
objects:
- description: >-
- Array of `rule_id` fields. Exports all rules when
- unspecified.
+ description: Array of `rule_id` fields. Exports all rules when unspecified.
items:
type: object
properties:
rule_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleSignatureId
+ $ref: '#/components/schemas/Security_Detections_API_RuleSignatureId'
required:
- rule_id
type: array
@@ -6462,12 +5979,10 @@ paths:
summary: Export detection rules
tags:
- Security Detections API
- - Import/Export API
+ x-beta: true
/api/detection_engine/rules/_find:
get:
- description: >-
- Retrieve a paginated list of detection rules. By default, the first page
- is returned, with 20 results per page.
+ description: Retrieve a paginated list of detection rules. By default, the first page is returned, with 20 results per page.
operationId: FindRules
parameters:
- in: query
@@ -6520,8 +6035,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleResponse
+ $ref: '#/components/schemas/Security_Detections_API_RuleResponse'
type: array
page:
type: integer
@@ -6538,39 +6052,30 @@ paths:
summary: List all detection rules
tags:
- Security Detections API
- - Rules API
+ x-beta: true
/api/detection_engine/rules/_import:
post:
- description: >
- Import detection rules from an `.ndjson` file, including actions and
- exception lists. The request must include:
-
+ description: |
+ Import detection rules from an `.ndjson` file, including actions and exception lists. The request must include:
- The `Content-Type: multipart/form-data` HTTP header.
-
- A link to the `.ndjson` file containing the rules.
operationId: ImportRules
parameters:
- - description: >-
- Determines whether existing rules with the same `rule_id` are
- overwritten.
+ - description: Determines whether existing rules with the same `rule_id` are overwritten.
in: query
name: overwrite
required: false
schema:
default: false
type: boolean
- - description: >-
- Determines whether existing exception lists with the same `list_id`
- are overwritten.
+ - description: Determines whether existing exception lists with the same `list_id` are overwritten.
in: query
name: overwrite_exceptions
required: false
schema:
default: false
type: boolean
- - description: >-
- Determines whether existing actions with the same
- `kibana.alert.rule.actions.id` are overwritten.
+ - description: Determines whether existing actions with the same `kibana.alert.rule.actions.id` are overwritten.
in: query
name: overwrite_action_connectors
required: false
@@ -6614,8 +6119,7 @@ paths:
type: integer
action_connectors_warnings:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_WarningSchema
+ $ref: '#/components/schemas/Security_Detections_API_WarningSchema'
type: array
errors:
items:
@@ -6654,7 +6158,7 @@ paths:
summary: Import detection rules
tags:
- Security Detections API
- - Import/Export API
+ x-beta: true
/api/detection_engine/rules/{id}/exceptions:
post:
description: Create exception items that apply to a single detection rule.
@@ -6674,8 +6178,7 @@ paths:
properties:
items:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemProps
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemProps'
type: array
required:
- items
@@ -6687,8 +6190,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItem
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItem'
type: array
description: Successful response
'400':
@@ -6696,24 +6198,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'500':
content:
@@ -6724,13 +6222,12 @@ paths:
summary: Create rule exception list items
tags:
- Security Exceptions API
+ x-beta: true
/api/detection_engine/rules/preview:
post:
operationId: RulePreview
parameters:
- - description: >-
- Enables logging and returning in response ES queries, performed
- during rule execution
+ - description: Enables logging and returning in response ES queries, performed during rule execution
in: query
name: enable_logged_requests
required: false
@@ -6742,50 +6239,32 @@ paths:
schema:
anyOf:
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_EqlRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_EqlRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_QueryRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_QueryRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_EsqlRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_EsqlRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
discriminator:
propertyName: type
- description: >-
- An object containing tags to add or remove and alert ids the changes
- will be applied
+ description: An object containing tags to add or remove and alert ids the changes will be applied
required: true
responses:
'200':
@@ -6798,12 +6277,10 @@ paths:
type: boolean
logs:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewLogs
+ $ref: '#/components/schemas/Security_Detections_API_RulePreviewLogs'
type: array
previewId:
- $ref: >-
- #/components/schemas/Security_Detections_API_NonEmptyString
+ $ref: '#/components/schemas/Security_Detections_API_NonEmptyString'
required:
- logs
description: Successful response
@@ -6812,17 +6289,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -6833,7 +6307,7 @@ paths:
summary: Preview rule alerts generated on specified time range
tags:
- Security Detections API
- - Rule preview API
+ x-beta: true
/api/detection_engine/signals/assignees:
post:
description: |
@@ -6865,6 +6339,7 @@ paths:
summary: Assign and unassign users from detection alerts
tags:
- Security Detections API
+ x-beta: true
/api/detection_engine/signals/search:
post:
description: Find and/or aggregate detection alerts that match the given query.
@@ -6919,17 +6394,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -6940,7 +6412,7 @@ paths:
summary: Find and/or aggregate detection alerts
tags:
- Security Detections API
- - Alerts API
+ x-beta: true
/api/detection_engine/signals/status:
post:
description: Set the status of one or more detection alerts.
@@ -6950,13 +6422,9 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_SetAlertsStatusByIds
- - $ref: >-
- #/components/schemas/Security_Detections_API_SetAlertsStatusByQuery
- description: >-
- An object containing desired status and explicit alert ids or a query
- to select alerts
+ - $ref: '#/components/schemas/Security_Detections_API_SetAlertsStatusByIds'
+ - $ref: '#/components/schemas/Security_Detections_API_SetAlertsStatusByQuery'
+ description: An object containing desired status and explicit alert ids or a query to select alerts
required: true
responses:
'200':
@@ -6972,17 +6440,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -6993,7 +6458,7 @@ paths:
summary: Set a detection alert status
tags:
- Security Detections API
- - Alerts API
+ x-beta: true
/api/detection_engine/signals/tags:
post:
description: |
@@ -7014,9 +6479,7 @@ paths:
required:
- ids
- tags
- description: >-
- An object containing tags to add or remove and alert ids the changes
- will be applied
+ description: An object containing tags to add or remove and alert ids the changes will be applied
required: true
responses:
'200':
@@ -7032,17 +6495,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -7053,7 +6513,7 @@ paths:
summary: Add and remove detection alert tags
tags:
- Security Detections API
- - Alerts API
+ x-beta: true
/api/detection_engine/tags:
get:
description: List all unique tags from all detection rules.
@@ -7068,61 +6528,51 @@ paths:
summary: List all detection rule tags
tags:
- Security Detections API
- - Tags API
+ x-beta: true
/api/endpoint_list:
post:
- description: >-
- Create an endpoint exception list, which groups endpoint exception list
- items. If an endpoint exception list already exists, an empty response
- is returned.
+ description: Create an endpoint exception list, which groups endpoint exception list items. If an endpoint exception list already exists, an empty response is returned.
operationId: CreateEndpointList
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointList
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointList'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Create an endpoint exception list
tags:
- Security Endpoint Exceptions API
+ x-beta: true
/api/endpoint_list/items:
delete:
- description: >-
- Delete an endpoint exception list item using the `id` or `item_id`
- field.
+ description: Delete an endpoint exception list item using the `id` or `item_id` field.
operationId: DeleteEndpointListItem
parameters:
- description: Either `id` or `item_id` must be specified
@@ -7130,68 +6580,58 @@ paths:
name: id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId'
- description: Either `id` or `item_id` must be specified
in: query
name: item_id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list item not found
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Delete an endpoint exception list item
tags:
- Security Endpoint Exceptions API
+ x-beta: true
get:
- description: >-
- Get the details of an endpoint exception list item using the `id` or
- `item_id` field.
+ description: Get the details of an endpoint exception list item using the `id` or `item_id` field.
operationId: ReadEndpointListItem
parameters:
- description: Either `id` or `item_id` must be specified
@@ -7199,23 +6639,20 @@ paths:
name: id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId'
- description: Either `id` or `item_id` must be specified
in: query
name: item_id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
type: array
description: Successful response
'400':
@@ -7223,46 +6660,39 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list item not found
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Get an endpoint exception list item
tags:
- Security Endpoint Exceptions API
+ x-beta: true
post:
- description: >-
- Create an endpoint exception list item, and associate it with the
- endpoint exception list.
+ description: Create an endpoint exception list item, and associate it with the endpoint exception list.
operationId: CreateEndpointListItem
requestBody:
content:
@@ -7271,35 +6701,26 @@ paths:
type: object
properties:
comments:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray'
item_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName'
os_types:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags'
default: []
type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType'
required:
- type
- name
@@ -7312,54 +6733,46 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'409':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list item already exists
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Create an endpoint exception list item
tags:
- Security Endpoint Exceptions API
+ x-beta: true
put:
- description: >-
- Update an endpoint exception list item using the `id` or `item_id`
- field.
+ description: Update an endpoint exception list item using the `id` or `item_id` field.
operationId: UpdateEndpointListItem
requestBody:
content:
@@ -7370,39 +6783,29 @@ paths:
_version:
type: string
comments:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray'
id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId'
description: Either `id` or `item_id` must be specified
item_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
description: Either `id` or `item_id` must be specified
meta:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName'
os_types:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags'
type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType'
required:
- type
- name
@@ -7415,66 +6818,57 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list item not found
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Update an endpoint exception list item
tags:
- Security Endpoint Exceptions API
+ x-beta: true
/api/endpoint_list/items/_find:
get:
description: Get a list of all endpoint exception list items.
operationId: FindEndpointListItems
parameters:
- - description: >
- Filters the returned results according to the value of the specified
- field,
-
+ - description: |
+ Filters the returned results according to the value of the specified field,
using the `:` syntax.
in: query
name: filter
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_FindEndpointListItemsFilter
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_FindEndpointListItemsFilter'
- description: The page number to return
in: query
name: page
@@ -7494,8 +6888,7 @@ paths:
name: sort_field
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
- description: Determines the sort order, which can be `desc` or `asc`
in: query
name: sort_order
@@ -7514,8 +6907,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
type: array
page:
minimum: 0
@@ -7539,42 +6931,37 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list not found
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Get endpoint exception list items
tags:
- Security Endpoint Exceptions API
+ x-beta: true
/api/endpoint/action:
get:
description: Get a list of all response actions.
@@ -7584,19 +6971,18 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_GetEndpointActionListRouteQuery
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_GetEndpointActionListRouteQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get response actions
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action_status:
get:
description: Get the status of response actions for the specified agent IDs.
@@ -7615,12 +7001,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ActionStatusSuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ActionStatusSuccessResponse'
description: OK
summary: Get response actions status
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/{action_id}:
get:
description: Get the details of a response action using the action ID.
@@ -7636,12 +7022,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get action details
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/{action_id}/file/{file_id}:
get:
description: Get information for the specified file using the file ID.
@@ -7662,12 +7048,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get file information
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/{action_id}/file/{file_id}/download:
get:
description: Download a file from an endpoint.
@@ -7688,12 +7074,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Download a file
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/execute:
post:
description: Run a shell command on an endpoint.
@@ -7702,20 +7088,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ExecuteRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ExecuteRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Run a command
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/get_file:
post:
description: Get a file from an endpoint.
@@ -7724,44 +7109,40 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_GetFileRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_GetFileRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get a file
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/isolate:
post:
- description: >-
- Isolate an endpoint from the network. The endpoint remains isolated
- until it's released.
+ description: Isolate an endpoint from the network. The endpoint remains isolated until it's released.
operationId: EndpointIsolateAction
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_IsolateRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_IsolateRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Isolate an endpoint
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/kill_process:
post:
description: Terminate a running process on an endpoint.
@@ -7770,20 +7151,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_KillProcessRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_KillProcessRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Terminate a process
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/running_procs:
post:
description: Get a list of all processes running on an endpoint.
@@ -7792,20 +7172,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_GetProcessesRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_GetProcessesRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get running processes
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/scan:
post:
description: Scan a specific file or directory on an endpoint for malware.
@@ -7814,37 +7193,34 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ScanRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ScanRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Scan a file or directory
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/state:
get:
- description: >-
- Get a response actions state, which reports whether encryption is
- enabled.
+ description: Get a response actions state, which reports whether encryption is enabled.
operationId: EndpointGetActionsState
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ActionStateSuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ActionStateSuccessResponse'
description: OK
summary: Get actions state
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/suspend_process:
post:
description: Suspend a running process on an endpoint.
@@ -7853,20 +7229,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuspendProcessRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuspendProcessRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Suspend a process
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/unisolate:
post:
description: Release an isolated endpoint, allowing it to rejoin a network.
@@ -7875,20 +7250,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_UnisolateRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_UnisolateRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Release an isolated endpoint
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/action/upload:
post:
description: Upload a file to an endpoint.
@@ -7897,20 +7271,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_UploadRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_UploadRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Upload a file
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/metadata:
get:
operationId: GetEndpointMetadataList
@@ -7919,19 +7292,18 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ListRequestQuery
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ListRequestQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get a metadata list
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/metadata/{id}:
get:
operationId: GetEndpointMetadata
@@ -7946,12 +7318,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get metadata
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/policy_response:
get:
operationId: GetPolicyResponse
@@ -7969,12 +7341,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get a policy response
tags:
- Security Endpoint Management API
+ x-beta: true
/api/endpoint/protection_updates_note/{package_policy_id}:
get:
operationId: GetProtectionUpdatesNote
@@ -7989,12 +7361,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse'
description: OK
summary: Get a protection updates note
tags:
- Security Endpoint Management API
+ x-beta: true
post:
operationId: CreateUpdateProtectionUpdatesNote
parameters:
@@ -8017,12 +7389,49 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse'
description: OK
summary: Create or update a protection updates note
tags:
- Security Endpoint Management API
+ x-beta: true
+ /api/entity_store/enable:
+ post:
+ operationId: InitEntityStore
+ requestBody:
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ schema:
+ type: object
+ properties:
+ fieldHistoryLength:
+ default: 10
+ description: The number of historical values to keep for each field.
+ type: integer
+ filter:
+ type: string
+ indexPattern:
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_IndexPattern'
+ description: Schema for the entity store initialization
+ required: true
+ responses:
+ '200':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ schema:
+ type: object
+ properties:
+ engines:
+ items:
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
+ type: array
+ succeeded:
+ type: boolean
+ description: Successful response
+ summary: Initialize the Entity Store
+ tags:
+ - Security Entity Analytics API
+ x-beta: true
/api/entity_store/engines:
get:
operationId: ListEntityEngines
@@ -8037,13 +7446,13 @@ paths:
type: integer
engines:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDescriptor
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
type: array
description: Successful response
summary: List the Entity Engines
tags:
- Security Entity Analytics API
+ x-beta: true
/api/entity_store/engines/{entityType}:
delete:
operationId: DeleteEntityEngine
@@ -8073,6 +7482,7 @@ paths:
summary: Delete the Entity Engine
tags:
- Security Entity Analytics API
+ x-beta: true
get:
operationId: GetEntityEngine
parameters:
@@ -8087,12 +7497,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDescriptor
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
description: Successful response
summary: Get an Entity Engine
tags:
- Security Entity Analytics API
+ x-beta: true
/api/entity_store/engines/{entityType}/init:
post:
operationId: InitEntityEngine
@@ -8116,8 +7526,7 @@ paths:
filter:
type: string
indexPattern:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_IndexPattern
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_IndexPattern'
description: Schema for the engine initialization
required: true
responses:
@@ -8125,12 +7534,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDescriptor
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
description: Successful response
summary: Initialize an Entity Engine
tags:
- Security Entity Analytics API
+ x-beta: true
/api/entity_store/engines/{entityType}/start:
post:
operationId: StartEntityEngine
@@ -8154,6 +7563,7 @@ paths:
summary: Start an Entity Engine
tags:
- Security Entity Analytics API
+ x-beta: true
/api/entity_store/engines/{entityType}/stats:
post:
operationId: GetEntityEngineStats
@@ -8172,26 +7582,24 @@ paths:
type: object
properties:
indexPattern:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_IndexPattern
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_IndexPattern'
indices:
items:
type: object
type: array
status:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineStatus
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineStatus'
transforms:
items:
type: object
type: array
type:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EntityType
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EntityType'
description: Successful response
summary: Get Entity Engine stats
tags:
- Security Entity Analytics API
+ x-beta: true
/api/entity_store/engines/{entityType}/stop:
post:
operationId: StopEntityEngine
@@ -8215,6 +7623,7 @@ paths:
summary: Stop an Entity Engine
tags:
- Security Entity Analytics API
+ x-beta: true
/api/entity_store/engines/apply_dataview_indices:
post:
operationId: ApplyEntityEngineDataviewIndices
@@ -8227,8 +7636,7 @@ paths:
properties:
result:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDataviewUpdateResult
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDataviewUpdateResult'
type: array
success:
type: boolean
@@ -8245,8 +7653,7 @@ paths:
type: array
result:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDataviewUpdateResult
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDataviewUpdateResult'
type: array
success:
type: boolean
@@ -8265,6 +7672,7 @@ paths:
summary: Apply DataView indices to all installed engines
tags:
- Security Entity Analytics API
+ x-beta: true
/api/entity_store/entities/list:
get:
description: List entities records, paging, sorting and filtering as needed.
@@ -8317,8 +7725,7 @@ paths:
type: object
properties:
inspect:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_InspectQuery
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_InspectQuery'
page:
minimum: 1
type: integer
@@ -8328,8 +7735,7 @@ paths:
type: integer
records:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_Entity
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
type: array
total:
minimum: 0
@@ -8343,6 +7749,28 @@ paths:
summary: List Entity Store Entities
tags:
- Security Entity Analytics API
+ x-beta: true
+ /api/entity_store/status:
+ get:
+ operationId: GetEntityStoreStatus
+ responses:
+ '200':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ schema:
+ type: object
+ properties:
+ engines:
+ items:
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
+ type: array
+ status:
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_StoreStatus'
+ description: Successful response
+ summary: Get the status of the Entity Store
+ tags:
+ - Security Entity Analytics API
+ x-beta: true
/api/exception_lists:
delete:
description: Delete an exception list using the `id` or `list_id` field.
@@ -8364,8 +7792,7 @@ paths:
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
responses:
'200':
@@ -8379,24 +7806,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -8413,6 +7836,7 @@ paths:
summary: Delete an exception list
tags:
- Security Exceptions API
+ x-beta: true
get:
description: Get the details of an exception list using the `id` or `list_id` field.
operationId: ReadExceptionList
@@ -8433,8 +7857,7 @@ paths:
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
responses:
'200':
@@ -8448,24 +7871,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -8482,20 +7901,12 @@ paths:
summary: Get exception list details
tags:
- Security Exceptions API
+ x-beta: true
post:
- description: >
- An exception list groups exception items and can be associated with
- detection rules. You can assign detection rules with multiple exception
- lists.
-
+ description: |
+ An exception list groups exception items and can be associated with detection rules. You can assign detection rules with multiple exception lists.
> info
-
- > All exception items added to the same list are evaluated using `OR`
- logic. That is, if any of the items in a list evaluate to `true`, the
- exception prevents the rule from generating an alert. Likewise, `OR`
- logic is used for evaluating exceptions when more than one exception
- list is assigned to a rule. To use the `AND` operator, you can define
- multiple clauses (`entries`) in a single exception item.
+ > All exception items added to the same list are evaluated using `OR` logic. That is, if any of the items in a list evaluate to `true`, the exception prevents the rule from generating an alert. Likewise, `OR` logic is used for evaluating exceptions when more than one exception list is assigned to a rule. To use the `AND` operator, you can define multiple clauses (`entries`) in a single exception item.
operationId: CreateExceptionList
requestBody:
content:
@@ -8504,34 +7915,25 @@ paths:
type: object
properties:
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListDescription'
list_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListMeta
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListMeta'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray'
tags:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListTags
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListTags'
default: []
type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListType'
version:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListVersion
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListVersion'
default: 1
required:
- name
@@ -8551,24 +7953,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'409':
content:
@@ -8585,6 +7983,7 @@ paths:
summary: Create an exception list
tags:
- Security Exceptions API
+ x-beta: true
put:
description: Update an exception list using the `id` or `list_id` field.
operationId: UpdateExceptionList
@@ -8597,36 +7996,27 @@ paths:
_version:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListDescription'
id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListId'
list_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListMeta
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListMeta'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListTags
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListTags'
type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListType'
version:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListVersion
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListVersion'
required:
- name
- description
@@ -8645,24 +8035,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -8679,6 +8065,7 @@ paths:
summary: Update an exception list
tags:
- Security Exceptions API
+ x-beta: true
/api/exception_lists/_duplicate:
post:
description: Duplicate an existing exception list.
@@ -8694,11 +8081,8 @@ paths:
name: namespace_type
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
- - description: >-
- Determines whether to include expired exceptions in the exported
- list
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
+ - description: Determines whether to include expired exceptions in the exported list
in: query
name: include_expired_exceptions
required: true
@@ -8720,24 +8104,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'405':
content:
@@ -8754,6 +8134,7 @@ paths:
summary: Duplicate an exception list
tags:
- Security Exceptions API
+ x-beta: true
/api/exception_lists/_export:
post:
description: Export an exception list and its associated items to an NDJSON file.
@@ -8775,11 +8156,8 @@ paths:
name: namespace_type
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
- - description: >-
- Determines whether to include expired exceptions in the exported
- list
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
+ - description: Determines whether to include expired exceptions in the exported list
in: query
name: include_expired_exceptions
required: true
@@ -8794,9 +8172,7 @@ paths:
content:
application/ndjson; Elastic-Api-Version=2023-10-31:
schema:
- description: >-
- A `.ndjson` file containing specified exception list and its
- items
+ description: A `.ndjson` file containing specified exception list and its items
format: binary
type: string
description: Successful response
@@ -8805,24 +8181,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -8839,34 +8211,26 @@ paths:
summary: Export an exception list
tags:
- Security Exceptions API
+ x-beta: true
/api/exception_lists/_find:
get:
description: Get a list of all exception lists.
operationId: FindExceptionLists
parameters:
- - description: >
- Filters the returned results according to the value of the specified
- field.
-
-
- Uses the `so type.field name:field` value syntax, where `so type`
- can be:
+ - description: |
+ Filters the returned results according to the value of the specified field.
+ Uses the `so type.field name:field` value syntax, where `so type` can be:
- `exception-list`: Specify a space-aware exception list.
-
- - `exception-list-agnostic`: Specify an exception list that is
- shared across spaces.
+ - `exception-list-agnostic`: Specify an exception list that is shared across spaces.
in: query
name: filter
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_FindExceptionListsFilter
- - description: >
- Determines whether the returned containers are Kibana associated
- with a Kibana space
-
+ $ref: '#/components/schemas/Security_Exceptions_API_FindExceptionListsFilter'
+ - description: |
+ Determines whether the returned containers are Kibana associated with a Kibana space
or available in all spaces (`agnostic` or `single`)
in: query
name: namespace_type
@@ -8875,8 +8239,7 @@ paths:
default:
- single
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
type: array
- description: The page number to return
in: query
@@ -8916,8 +8279,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionList
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionList'
type: array
page:
minimum: 1
@@ -8939,24 +8301,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'500':
content:
@@ -8967,17 +8325,15 @@ paths:
summary: Get exception lists
tags:
- Security Exceptions API
+ x-beta: true
/api/exception_lists/_import:
post:
description: Import an exception list and its associated items from an NDJSON file.
operationId: ImportExceptionList
parameters:
- - description: >
- Determines whether existing exception lists with the same `list_id`
- are overwritten.
-
- If any exception items have the same `item_id`, those are also
- overwritten.
+ - description: |
+ Determines whether existing exception lists with the same `list_id` are overwritten.
+ If any exception items have the same `item_id`, those are also overwritten.
in: query
name: overwrite
required: false
@@ -8996,13 +8352,9 @@ paths:
schema:
default: false
type: boolean
- - description: >
- Determines whether the list being imported will have a new `list_id`
- generated.
-
- Additional `item_id`'s are generated for each exception item. Both
- the exception
-
+ - description: |
+ Determines whether the list being imported will have a new `list_id` generated.
+ Additional `item_id`'s are generated for each exception item. Both the exception
list and its items are overwritten.
in: query
name: as_new_list
@@ -9029,8 +8381,7 @@ paths:
type: object
properties:
errors:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListsImportBulkErrorArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListsImportBulkErrorArray'
success:
type: boolean
success_count:
@@ -9060,24 +8411,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'500':
content:
@@ -9088,6 +8435,7 @@ paths:
summary: Import an exception list
tags:
- Security Exceptions API
+ x-beta: true
/api/exception_lists/items:
delete:
description: Delete an exception list item using the `id` or `item_id` field.
@@ -9104,14 +8452,12 @@ paths:
name: item_id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
- in: query
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
responses:
'200':
@@ -9125,24 +8471,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -9159,10 +8501,9 @@ paths:
summary: Delete an exception list item
tags:
- Security Exceptions API
+ x-beta: true
get:
- description: >-
- Get the details of an exception list item using the `id` or `item_id`
- field.
+ description: Get the details of an exception list item using the `id` or `item_id` field.
operationId: ReadExceptionListItem
parameters:
- description: Either `id` or `item_id` must be specified
@@ -9176,14 +8517,12 @@ paths:
name: item_id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
- in: query
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
responses:
'200':
@@ -9197,24 +8536,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -9231,13 +8566,11 @@ paths:
summary: Get an exception list item
tags:
- Security Exceptions API
+ x-beta: true
post:
- description: >
- Create an exception item and associate it with the specified exception
- list.
-
+ description: |
+ Create an exception item and associate it with the specified exception list.
> info
-
> Before creating exception items, you must create an exception list.
operationId: CreateExceptionListItem
requestBody:
@@ -9247,45 +8580,34 @@ paths:
type: object
properties:
comments:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
list_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemTags'
default: []
type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemType'
required:
- list_id
- type
@@ -9306,24 +8628,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'409':
content:
@@ -9340,6 +8658,7 @@ paths:
summary: Create an exception list item
tags:
- Security Exceptions API
+ x-beta: true
put:
description: Update an exception list item using the `id` or `item_id` field.
operationId: UpdateExceptionListItem
@@ -9352,49 +8671,37 @@ paths:
_version:
type: string
comments:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_UpdateExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Exceptions_API_UpdateExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemId'
description: Either `id` or `item_id` must be specified
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
description: Either `id` or `item_id` must be specified
list_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemTags'
type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemType'
required:
- type
- name
@@ -9414,24 +8721,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -9448,6 +8751,7 @@ paths:
summary: Update an exception list item
tags:
- Security Exceptions API
+ x-beta: true
/api/exception_lists/items/_find:
get:
description: Get a list of all exception list items in the specified list.
@@ -9459,13 +8763,10 @@ paths:
required: true
schema:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
type: array
- - description: >
- Filters the returned results according to the value of the specified
- field,
-
+ - description: |
+ Filters the returned results according to the value of the specified field,
using the `:` syntax.
in: query
name: filter
@@ -9473,13 +8774,10 @@ paths:
schema:
default: []
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_FindExceptionListItemsFilter
+ $ref: '#/components/schemas/Security_Exceptions_API_FindExceptionListItemsFilter'
type: array
- - description: >
- Determines whether the returned containers are Kibana associated
- with a Kibana space
-
+ - description: |
+ Determines whether the returned containers are Kibana associated with a Kibana space
or available in all spaces (`agnostic` or `single`)
in: query
name: namespace_type
@@ -9488,8 +8786,7 @@ paths:
default:
- single
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
type: array
- in: query
name: search
@@ -9534,8 +8831,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItem
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItem'
type: array
page:
minimum: 1
@@ -9559,24 +8855,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -9593,6 +8885,7 @@ paths:
summary: Get exception list items
tags:
- Security Exceptions API
+ x-beta: true
/api/exception_lists/summary:
get:
description: Get a summary of the specified exception list.
@@ -9614,8 +8907,7 @@ paths:
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
- description: Search filter clause
in: query
@@ -9648,24 +8940,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -9682,21 +8970,13 @@ paths:
summary: Get an exception list summary
tags:
- Security Exceptions API
+ x-beta: true
/api/exceptions/shared:
post:
- description: >
- An exception list groups exception items and can be associated with
- detection rules. A shared exception list can apply to multiple detection
- rules.
-
+ description: |
+ An exception list groups exception items and can be associated with detection rules. A shared exception list can apply to multiple detection rules.
> info
-
- > All exception items added to the same list are evaluated using `OR`
- logic. That is, if any of the items in a list evaluate to `true`, the
- exception prevents the rule from generating an alert. Likewise, `OR`
- logic is used for evaluating exceptions when more than one exception
- list is assigned to a rule. To use the `AND` operator, you can define
- multiple clauses (`entries`) in a single exception item.
+ > All exception items added to the same list are evaluated using `OR` logic. That is, if any of the items in a list evaluate to `true`, the exception prevents the rule from generating an alert. Likewise, `OR` logic is used for evaluating exceptions when more than one exception list is assigned to a rule. To use the `AND` operator, you can define multiple clauses (`entries`) in a single exception item.
operationId: CreateSharedExceptionList
requestBody:
content:
@@ -9705,11 +8985,9 @@ paths:
type: object
properties:
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListDescription'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListName'
required:
- name
- description
@@ -9726,24 +9004,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'409':
content:
@@ -9760,6 +9034,7 @@ paths:
summary: Create a shared exception list
tags:
- Security Exceptions API
+ x-beta: true
/api/fleet/agent_download_sources:
get:
operationId: get-fleet-agent-download-sources
@@ -9796,9 +9071,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source.
- See the proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -9836,6 +9109,7 @@ paths:
summary: Get agent binary download sources
tags:
- Elastic Agent binary download sources
+ x-beta: true
post:
operationId: post-fleet-agent-download-sources
parameters:
@@ -9872,9 +9146,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source. See the
- proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -9903,9 +9175,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source.
- See the proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -9933,6 +9203,7 @@ paths:
summary: Create an agent binary download source
tags:
- Elastic Agent binary download sources
+ x-beta: true
/api/fleet/agent_download_sources/{sourceId}:
delete:
description: Delete an agent binary download source by ID.
@@ -9989,6 +9260,7 @@ paths:
summary: Delete an agent binary download source
tags:
- Elastic Agent binary download sources
+ x-beta: true
get:
description: Get an agent binary download source by ID.
operationId: get-fleet-agent-download-sources-sourceid
@@ -10029,9 +9301,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source.
- See the proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -10059,6 +9329,7 @@ paths:
summary: Get an agent binary download source
tags:
- Elastic Agent binary download sources
+ x-beta: true
put:
description: Update an agent binary download source by ID.
operationId: put-fleet-agent-download-sources-sourceid
@@ -10101,9 +9372,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source. See the
- proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -10132,9 +9401,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source.
- See the proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -10162,6 +9429,7 @@ paths:
summary: Update an agent binary download source
tags:
- Elastic Agent binary download sources
+ x-beta: true
/api/fleet/agent_policies:
get:
operationId: get-fleet-agent-policies
@@ -10291,9 +9559,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -10325,15 +9591,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -10400,11 +9662,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -10412,10 +9670,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list
- of agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -10461,9 +9716,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -10491,9 +9744,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -10546,9 +9797,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -10569,9 +9818,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -10585,20 +9832,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank
- to inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -10647,16 +9888,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package
- policy will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -10687,9 +9924,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -10719,9 +9954,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports
- agentless integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -10776,6 +10009,7 @@ paths:
summary: Get agent policies
tags:
- Elastic Agent policies
+ x-beta: true
post:
operationId: post-fleet-agent-policies
parameters:
@@ -10850,9 +10084,7 @@ paths:
force:
type: boolean
global_data_tags:
- description: >-
- User defined data tags that are added to all of the inputs.
- The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -10885,9 +10117,7 @@ paths:
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -10954,11 +10184,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
space_ids:
@@ -10967,9 +10193,7 @@ paths:
type: array
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -11034,9 +10258,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -11068,15 +10290,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -11143,11 +10361,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -11155,10 +10369,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list of
- agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -11204,9 +10415,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -11234,9 +10443,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -11289,9 +10496,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -11312,9 +10517,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -11328,20 +10531,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -11390,16 +10587,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -11430,9 +10623,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -11462,9 +10653,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -11509,6 +10698,7 @@ paths:
summary: Create an agent policy
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_policies/_bulk_get:
post:
operationId: post-fleet-agent-policies-bulk-get
@@ -11612,9 +10802,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -11646,15 +10834,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -11721,11 +10905,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -11733,10 +10913,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list
- of agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -11782,9 +10959,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -11812,9 +10987,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -11867,9 +11040,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -11890,9 +11061,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -11906,20 +11075,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank
- to inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -11968,16 +11131,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package
- policy will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -12008,9 +11167,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -12040,9 +11197,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports
- agentless integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -12088,6 +11243,7 @@ paths:
summary: Bulk get agent policies
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_policies/{agentPolicyId}:
get:
description: Get an agent policy by ID.
@@ -12170,9 +11326,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -12204,15 +11358,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -12279,11 +11429,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -12291,10 +11437,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list of
- agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -12340,9 +11483,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -12370,9 +11511,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -12425,9 +11564,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -12448,9 +11585,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -12464,20 +11599,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -12526,16 +11655,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -12566,9 +11691,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -12598,9 +11721,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -12645,6 +11766,7 @@ paths:
summary: Get an agent policy
tags:
- Elastic Agent policies
+ x-beta: true
put:
description: Update an agent policy by ID.
operationId: put-fleet-agent-policies-agentpolicyid
@@ -12728,9 +11850,7 @@ paths:
force:
type: boolean
global_data_tags:
- description: >-
- User defined data tags that are added to all of the inputs.
- The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -12763,9 +11883,7 @@ paths:
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -12832,11 +11950,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
space_ids:
@@ -12845,9 +11959,7 @@ paths:
type: array
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -12912,9 +12024,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -12946,15 +12056,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -13021,11 +12127,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -13033,10 +12135,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list of
- agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -13082,9 +12181,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -13112,9 +12209,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -13167,9 +12262,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -13190,9 +12283,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -13206,20 +12297,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -13268,16 +12353,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -13308,9 +12389,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -13340,9 +12419,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -13387,6 +12464,7 @@ paths:
summary: Update an agent policy
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_policies/{agentPolicyId}/copy:
post:
description: Copy an agent policy by ID.
@@ -13490,9 +12568,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -13524,15 +12600,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -13599,11 +12671,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -13611,10 +12679,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list of
- agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -13660,9 +12725,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -13690,9 +12753,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -13745,9 +12806,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -13768,9 +12827,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -13784,20 +12841,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -13846,16 +12897,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -13886,9 +12933,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -13918,9 +12963,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -13965,6 +13008,7 @@ paths:
summary: Copy an agent policy
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_policies/{agentPolicyId}/download:
get:
description: Download an agent policy by ID.
@@ -14039,6 +13083,7 @@ paths:
summary: Download an agent policy
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_policies/{agentPolicyId}/full:
get:
description: Get a full agent policy by ID.
@@ -14371,6 +13416,7 @@ paths:
summary: Get a full agent policy
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_policies/{agentPolicyId}/outputs:
get:
description: Get a list of outputs associated with agent policy by policy id.
@@ -14475,6 +13521,7 @@ paths:
summary: Get outputs for an agent policy
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_policies/delete:
post:
description: Delete an agent policy by ID.
@@ -14505,9 +13552,7 @@ paths:
agentPolicyId:
type: string
force:
- description: >-
- bypass validation checks that can prevent agent policy
- deletion
+ description: bypass validation checks that can prevent agent policy deletion
type: boolean
required:
- agentPolicyId
@@ -14545,6 +13590,7 @@ paths:
summary: Delete an agent policy
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_policies/outputs:
post:
description: Get a list of outputs associated with agent policies.
@@ -14667,6 +13713,7 @@ paths:
summary: Get outputs for agent policies
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/agent_status:
get:
operationId: get-fleet-agent-status
@@ -14762,6 +13809,7 @@ paths:
summary: Get an agent status summary
tags:
- Elastic Agent status
+ x-beta: true
/api/fleet/agent_status/data:
get:
operationId: get-fleet-agent-status-data
@@ -14834,6 +13882,7 @@ paths:
summary: Get incoming agent data
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/agents:
get:
operationId: get-fleet-agents
@@ -15220,6 +14269,7 @@ paths:
summary: Get agents
tags:
- Elastic Agents
+ x-beta: true
post:
operationId: post-fleet-agents
parameters:
@@ -15284,6 +14334,7 @@ paths:
summary: Get agents by action ids
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/agents/{agentId}:
delete:
description: Delete an agent by ID.
@@ -15342,6 +14393,7 @@ paths:
summary: Delete an agent
tags:
- Elastic Agents
+ x-beta: true
get:
description: Get an agent by ID.
operationId: get-fleet-agents-agentid
@@ -15670,6 +14722,7 @@ paths:
summary: Get an agent
tags:
- Elastic Agents
+ x-beta: true
put:
description: Update an agent by ID.
operationId: put-fleet-agents-agentid
@@ -16013,6 +15066,7 @@ paths:
summary: Update an agent
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/agents/{agentId}/actions:
post:
operationId: post-fleet-agents-agentid-actions
@@ -16157,6 +15211,7 @@ paths:
summary: Create an agent action
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/{agentId}/reassign:
post:
operationId: post-fleet-agents-agentid-reassign
@@ -16219,6 +15274,7 @@ paths:
summary: Reassign an agent
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/{agentId}/request_diagnostics:
post:
operationId: post-fleet-agents-agentid-request-diagnostics
@@ -16288,6 +15344,7 @@ paths:
summary: Request agent diagnostics
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/{agentId}/unenroll:
post:
operationId: post-fleet-agents-agentid-unenroll
@@ -16328,6 +15385,7 @@ paths:
summary: Unenroll an agent
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/{agentId}/upgrade:
post:
operationId: post-fleet-agents-agentid-upgrade
@@ -16396,6 +15454,7 @@ paths:
summary: Upgrade an agent
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/{agentId}/uploads:
get:
operationId: get-fleet-agents-agentid-uploads
@@ -16476,6 +15535,7 @@ paths:
summary: Get agent uploads
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/agents/action_status:
get:
operationId: get-fleet-agents-action-status
@@ -16545,9 +15605,7 @@ paths:
latestErrors:
items:
additionalProperties: false
- description: >-
- latest errors that happened when the agents
- executed the action
+ description: latest errors that happened when the agents executed the action
type: object
properties:
agentId:
@@ -16643,6 +15701,7 @@ paths:
summary: Get an agent action status
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/actions/{actionId}/cancel:
post:
operationId: post-fleet-agents-actions-actionid-cancel
@@ -16737,6 +15796,7 @@ paths:
summary: Cancel an agent action
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/available_versions:
get:
operationId: get-fleet-agents-available-versions
@@ -16782,6 +15842,7 @@ paths:
summary: Get available agent versions
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/agents/bulk_reassign:
post:
operationId: post-fleet-agents-bulk-reassign
@@ -16855,6 +15916,7 @@ paths:
summary: Bulk reassign agents
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/bulk_request_diagnostics:
post:
operationId: post-fleet-agents-bulk-request-diagnostics
@@ -16928,6 +15990,7 @@ paths:
summary: Bulk request diagnostics from agents
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/bulk_unenroll:
post:
operationId: post-fleet-agents-bulk-unenroll
@@ -16968,9 +16031,7 @@ paths:
description: Unenrolls hosted agents too
type: boolean
includeInactive:
- description: >-
- When passing agents by KQL query, unenrolls inactive agents
- too
+ description: When passing agents by KQL query, unenrolls inactive agents too
type: boolean
revoke:
description: Revokes API keys of agents
@@ -17008,6 +16069,7 @@ paths:
summary: Bulk unenroll agents
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/bulk_update_agent_tags:
post:
operationId: post-fleet-agents-bulk-update-agent-tags
@@ -17086,6 +16148,7 @@ paths:
summary: Bulk update agent tags
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/bulk_upgrade:
post:
operationId: post-fleet-agents-bulk-upgrade
@@ -17170,6 +16233,7 @@ paths:
summary: Bulk upgrade agents
tags:
- Elastic Agent actions
+ x-beta: true
/api/fleet/agents/files/{fileId}:
delete:
description: Delete a file uploaded by an agent.
@@ -17229,6 +16293,7 @@ paths:
summary: Delete an uploaded file
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/agents/files/{fileId}/{fileName}:
get:
description: Get a file uploaded by an agent.
@@ -17277,6 +16342,7 @@ paths:
summary: Get an uploaded file
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/agents/setup:
get:
operationId: get-fleet-agents-setup
@@ -17295,10 +16361,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
additionalProperties: false
- description: >-
- A summary of the agent setup status. `isReady` indicates
- whether the setup is ready. If the setup is not ready,
- `missing_requirements` lists which requirements are missing.
+ description: A summary of the agent setup status. `isReady` indicates whether the setup is ready. If the setup is not ready, `missing_requirements` lists which requirements are missing.
type: object
properties:
is_secrets_storage_enabled:
@@ -17348,6 +16411,7 @@ paths:
summary: Get agent setup info
tags:
- Elastic Agents
+ x-beta: true
post:
operationId: post-fleet-agents-setup
parameters:
@@ -17372,11 +16436,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
additionalProperties: false
- description: >-
- A summary of the result of Fleet's `setup` lifecycle. If
- `isInitialized` is true, Fleet is ready to accept agent
- enrollment. `nonFatalErrors` may include useful insight into
- non-blocking issues with Fleet setup.
+ description: A summary of the result of Fleet's `setup` lifecycle. If `isInitialized` is true, Fleet is ready to accept agent enrollment. `nonFatalErrors` may include useful insight into non-blocking issues with Fleet setup.
type: object
properties:
isInitialized:
@@ -17416,6 +16476,7 @@ paths:
summary: Initiate agent setup
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/agents/tags:
get:
operationId: get-fleet-agents-tags
@@ -17472,6 +16533,7 @@ paths:
summary: Get agent tags
tags:
- Elastic Agents
+ x-beta: true
/api/fleet/check-permissions:
get:
operationId: get-fleet-check-permissions
@@ -17526,6 +16588,7 @@ paths:
summary: Check permissions
tags:
- Fleet internals
+ x-beta: true
/api/fleet/data_streams:
get:
operationId: get-fleet-data-streams
@@ -17630,6 +16693,7 @@ paths:
summary: Get data streams
tags:
- Data streams
+ x-beta: true
/api/fleet/enrollment_api_keys:
get:
operationId: get-fleet-enrollment-api-keys
@@ -17673,14 +16737,42 @@ paths:
type: object
properties:
active:
- description: >-
- When false, the enrollment API key is revoked and
- cannot be used for enrolling Elastic Agents.
+ description: When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.
+ type: boolean
+ api_key:
+ description: The enrollment API key (token) used for enrolling Elastic Agents.
+ type: string
+ api_key_id:
+ description: The ID of the API key in the Security API.
+ type: string
+ created_at:
+ type: string
+ id:
+ type: string
+ name:
+ description: The name of the enrollment API key.
+ type: string
+ policy_id:
+ description: The ID of the agent policy the Elastic Agent will be enrolled in.
+ type: string
+ required:
+ - id
+ - api_key_id
+ - api_key
+ - active
+ - created_at
+ type: array
+ list:
+ deprecated: true
+ items:
+ additionalProperties: false
+ type: object
+ properties:
+ active:
+ description: When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.
type: boolean
api_key:
- description: >-
- The enrollment API key (token) used for enrolling
- Elastic Agents.
+ description: The enrollment API key (token) used for enrolling Elastic Agents.
type: string
api_key_id:
description: The ID of the API key in the Security API.
@@ -17693,9 +16785,7 @@ paths:
description: The name of the enrollment API key.
type: string
policy_id:
- description: >-
- The ID of the agent policy the Elastic Agent will be
- enrolled in.
+ description: The ID of the agent policy the Elastic Agent will be enrolled in.
type: string
required:
- id
@@ -17715,6 +16805,7 @@ paths:
- total
- page
- perPage
+ - list
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -17734,6 +16825,7 @@ paths:
summary: Get enrollment API keys
tags:
- Fleet enrollment API keys
+ x-beta: true
post:
operationId: post-fleet-enrollment-api-keys
parameters:
@@ -17784,14 +16876,10 @@ paths:
type: object
properties:
active:
- description: >-
- When false, the enrollment API key is revoked and
- cannot be used for enrolling Elastic Agents.
+ description: When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.
type: boolean
api_key:
- description: >-
- The enrollment API key (token) used for enrolling
- Elastic Agents.
+ description: The enrollment API key (token) used for enrolling Elastic Agents.
type: string
api_key_id:
description: The ID of the API key in the Security API.
@@ -17804,9 +16892,7 @@ paths:
description: The name of the enrollment API key.
type: string
policy_id:
- description: >-
- The ID of the agent policy the Elastic Agent will be
- enrolled in.
+ description: The ID of the agent policy the Elastic Agent will be enrolled in.
type: string
required:
- id
@@ -17836,6 +16922,7 @@ paths:
summary: Create an enrollment API key
tags:
- Fleet enrollment API keys
+ x-beta: true
/api/fleet/enrollment_api_keys/{keyId}:
delete:
description: Revoke an enrollment API key by ID by marking it as inactive.
@@ -17894,6 +16981,7 @@ paths:
summary: Revoke an enrollment API key
tags:
- Fleet enrollment API keys
+ x-beta: true
get:
description: Get an enrollment API key by ID.
operationId: get-fleet-enrollment-api-keys-keyid
@@ -17924,14 +17012,10 @@ paths:
type: object
properties:
active:
- description: >-
- When false, the enrollment API key is revoked and
- cannot be used for enrolling Elastic Agents.
+ description: When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.
type: boolean
api_key:
- description: >-
- The enrollment API key (token) used for enrolling
- Elastic Agents.
+ description: The enrollment API key (token) used for enrolling Elastic Agents.
type: string
api_key_id:
description: The ID of the API key in the Security API.
@@ -17944,9 +17028,7 @@ paths:
description: The name of the enrollment API key.
type: string
policy_id:
- description: >-
- The ID of the agent policy the Elastic Agent will be
- enrolled in.
+ description: The ID of the agent policy the Elastic Agent will be enrolled in.
type: string
required:
- id
@@ -17975,6 +17057,7 @@ paths:
summary: Get an enrollment API key
tags:
- Fleet enrollment API keys
+ x-beta: true
/api/fleet/epm/bulk_assets:
post:
operationId: post-fleet-epm-bulk-assets
@@ -18073,6 +17156,7 @@ paths:
summary: Bulk get assets
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/categories:
get:
operationId: get-fleet-epm-categories
@@ -18144,6 +17228,7 @@ paths:
summary: Get package categories
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/custom_integrations:
post:
operationId: post-fleet-epm-custom-integrations
@@ -18286,6 +17371,7 @@ paths:
summary: Create a custom integration
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/data_streams:
get:
operationId: get-fleet-epm-data-streams
@@ -18368,6 +17454,7 @@ paths:
summary: Get data streams
tags:
- Data streams
+ x-beta: true
/api/fleet/epm/packages:
get:
operationId: get-fleet-epm-packages
@@ -18768,6 +17855,7 @@ paths:
summary: Get packages
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
post:
operationId: post-fleet-epm-packages
parameters:
@@ -18894,6 +17982,7 @@ paths:
summary: Install a package by upload
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/packages/_bulk:
post:
operationId: post-fleet-epm-packages-bulk
@@ -19076,6 +18165,7 @@ paths:
summary: Bulk install packages
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/packages/{pkgName}/{pkgVersion}:
delete:
operationId: delete-fleet-epm-packages-pkgname-pkgversion
@@ -19191,6 +18281,7 @@ paths:
summary: Delete a package
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
get:
operationId: get-fleet-epm-packages-pkgname-pkgversion
parameters:
@@ -19670,6 +18761,7 @@ paths:
summary: Get a package
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
post:
operationId: post-fleet-epm-packages-pkgname-pkgversion
parameters:
@@ -19819,6 +18911,7 @@ paths:
summary: Install a package from the registry
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
put:
operationId: put-fleet-epm-packages-pkgname-pkgversion
parameters:
@@ -20287,7 +19380,8 @@ paths:
summary: Update package settings
tags:
- Elastic Package Manager (EPM)
- /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath*}:
+ x-beta: true
+ /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath}:
get:
operationId: get-fleet-epm-packages-pkgname-pkgversion-filepath
parameters:
@@ -20338,6 +19432,7 @@ paths:
summary: Get a package file
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize:
post:
operationId: post-fleet-epm-packages-pkgname-pkgversion-transforms-authorize
@@ -20430,6 +19525,7 @@ paths:
summary: Authorize transforms
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/packages/{pkgName}/stats:
get:
operationId: get-fleet-epm-packages-pkgname-stats
@@ -20484,6 +19580,7 @@ paths:
summary: Get package stats
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/packages/installed:
get:
operationId: get-fleet-epm-packages-installed
@@ -20637,6 +19734,7 @@ paths:
summary: Get installed packages
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/packages/limited:
get:
operationId: get-fleet-epm-packages-limited
@@ -20682,6 +19780,7 @@ paths:
summary: Get a limited package list
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs:
get:
operationId: get-fleet-epm-templates-pkgname-pkgversion-inputs
@@ -20789,6 +19888,7 @@ paths:
summary: Get an inputs template
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/epm/verification_key_id:
get:
operationId: get-fleet-epm-verification-key-id
@@ -20833,6 +19933,7 @@ paths:
summary: Get a package signature verification key ID
tags:
- Elastic Package Manager (EPM)
+ x-beta: true
/api/fleet/fleet_server_hosts:
get:
operationId: get-fleet-fleet-server-hosts
@@ -20913,6 +20014,7 @@ paths:
summary: Get Fleet Server hosts
tags:
- Fleet Server hosts
+ x-beta: true
post:
operationId: post-fleet-fleet-server-hosts
parameters:
@@ -21018,6 +20120,7 @@ paths:
summary: Create a Fleet Server host
tags:
- Fleet Server hosts
+ x-beta: true
/api/fleet/fleet_server_hosts/{itemId}:
delete:
description: Delete a Fleet Server host by ID.
@@ -21074,6 +20177,7 @@ paths:
summary: Delete a Fleet Server host
tags:
- Fleet Server hosts
+ x-beta: true
get:
description: Get a Fleet Server host by ID.
operationId: get-fleet-fleet-server-hosts-itemid
@@ -21148,6 +20252,7 @@ paths:
summary: Get a Fleet Server host
tags:
- Fleet Server hosts
+ x-beta: true
put:
description: Update a Fleet Server host by ID.
operationId: put-fleet-fleet-server-hosts-itemid
@@ -21252,6 +20357,7 @@ paths:
summary: Update a Fleet Server host
tags:
- Fleet Server hosts
+ x-beta: true
/api/fleet/health_check:
post:
operationId: post-fleet-health-check
@@ -21333,6 +20439,7 @@ paths:
summary: Check Fleet Server health
tags:
- Fleet internals
+ x-beta: true
/api/fleet/kubernetes:
get:
operationId: get-fleet-kubernetes
@@ -21391,6 +20498,7 @@ paths:
summary: Get a full K8s agent manifest
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/kubernetes/download:
get:
operationId: get-fleet-kubernetes-download
@@ -21459,6 +20567,7 @@ paths:
summary: Download an agent manifest
tags:
- Elastic Agent policies
+ x-beta: true
/api/fleet/logstash_api_keys:
post:
operationId: post-fleet-logstash-api-keys
@@ -21509,6 +20618,7 @@ paths:
summary: Generate a Logstash API key
tags:
- Fleet outputs
+ x-beta: true
/api/fleet/message_signing_service/rotate_key_pair:
post:
operationId: post-fleet-message-signing-service-rotate-key-pair
@@ -21581,6 +20691,7 @@ paths:
summary: Rotate a Fleet message signing key pair
tags:
- Message Signing Service
+ x-beta: true
/api/fleet/outputs:
get:
operationId: get-fleet-outputs
@@ -22314,6 +21425,7 @@ paths:
summary: Get outputs
tags:
- Fleet outputs
+ x-beta: true
post:
operationId: post-fleet-outputs
parameters:
@@ -23726,6 +22838,7 @@ paths:
summary: Create output
tags:
- Fleet outputs
+ x-beta: true
/api/fleet/outputs/{outputId}:
delete:
description: Delete output by ID.
@@ -23798,6 +22911,7 @@ paths:
summary: Delete output
tags:
- Fleet outputs
+ x-beta: true
get:
description: Get output by ID.
operationId: get-fleet-outputs-outputid
@@ -24525,6 +23639,7 @@ paths:
summary: Get output
tags:
- Fleet outputs
+ x-beta: true
put:
description: Update output by ID.
operationId: put-fleet-outputs-outputid
@@ -25922,6 +25037,7 @@ paths:
summary: Update output
tags:
- Fleet outputs
+ x-beta: true
/api/fleet/outputs/{outputId}/health:
get:
operationId: get-fleet-outputs-outputid-health
@@ -25979,6 +25095,7 @@ paths:
summary: Get the latest output health
tags:
- Fleet outputs
+ x-beta: true
/api/fleet/package_policies:
get:
operationId: get-fleet-package-policies
@@ -26094,9 +25211,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -26124,9 +25239,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -26179,9 +25292,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -26202,9 +25313,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -26217,9 +25326,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -26227,9 +25334,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -26254,15 +25359,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration
- documentation to know what streams are
- available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -26287,14 +25386,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -26303,20 +25397,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine
- procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -26365,16 +25453,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -26410,9 +25494,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -26436,9 +25518,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -26484,6 +25564,7 @@ paths:
summary: Get package policies
tags:
- Fleet package policies
+ x-beta: true
post:
operationId: post-fleet-package-policies
parameters:
@@ -26524,9 +25605,7 @@ paths:
enabled:
type: boolean
force:
- description: >-
- Force package policy creation even if package is not
- verified, or if the agent policy is managed.
+ description: Force package policy creation even if package is not verified, or if the agent policy is managed.
type: boolean
id:
description: Package policy unique identifier
@@ -26548,9 +25627,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -26578,9 +25655,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -26633,9 +25708,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -26656,9 +25729,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -26670,19 +25741,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit the
- agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -26736,9 +25802,7 @@ paths:
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
vars:
@@ -26753,9 +25817,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation for more
- information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- name
@@ -26783,9 +25845,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default to
- true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -26810,13 +25870,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation to
- know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -26841,13 +25897,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration documentation to
- know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
name:
type: string
@@ -26926,16 +25978,12 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
required:
- name
- package
- description: >-
- You should use inputs as an object and not use the deprecated
- inputs array.
+ description: You should use inputs as an object and not use the deprecated inputs array.
responses:
'200':
content:
@@ -26992,9 +26040,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -27022,9 +26068,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -27077,9 +26121,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -27100,9 +26142,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -27115,9 +26155,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -27125,9 +26163,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -27152,14 +26188,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation
- to know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -27184,13 +26215,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -27199,19 +26226,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -27260,16 +26282,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -27305,9 +26323,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -27331,9 +26347,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -27385,6 +26399,7 @@ paths:
summary: Create a package policy
tags:
- Fleet package policies
+ x-beta: true
/api/fleet/package_policies/_bulk_get:
post:
operationId: post-fleet-package-policies-bulk-get
@@ -27485,9 +26500,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -27515,9 +26528,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -27570,9 +26581,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -27593,9 +26602,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -27608,9 +26615,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -27618,9 +26623,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -27645,15 +26648,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration
- documentation to know what streams are
- available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -27678,14 +26675,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -27694,20 +26686,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine
- procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -27756,16 +26742,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -27801,9 +26783,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -27827,9 +26807,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -27877,6 +26855,7 @@ paths:
summary: Bulk get package policies
tags:
- Fleet package policies
+ x-beta: true
/api/fleet/package_policies/{packagePolicyId}:
delete:
description: Delete a package policy by ID.
@@ -27938,6 +26917,7 @@ paths:
summary: Delete a package policy
tags:
- Fleet package policies
+ x-beta: true
get:
description: Get a package policy by ID.
operationId: get-fleet-package-policies-packagepolicyid
@@ -28019,9 +26999,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -28049,9 +27027,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -28104,9 +27080,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -28127,9 +27101,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -28142,9 +27114,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -28152,9 +27122,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -28179,14 +27147,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation
- to know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -28211,13 +27174,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -28226,19 +27185,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -28287,16 +27241,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -28332,9 +27282,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -28358,9 +27306,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -28407,6 +27353,7 @@ paths:
summary: Get a package policy
tags:
- Fleet package policies
+ x-beta: true
put:
description: Update a package policy by ID.
operationId: put-fleet-package-policies-packagepolicyid
@@ -28471,9 +27418,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -28501,9 +27446,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -28556,9 +27499,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -28579,9 +27520,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -28592,19 +27531,14 @@ paths:
name:
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit the
- agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -28658,9 +27592,7 @@ paths:
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
vars:
@@ -28675,9 +27607,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation for more
- information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -28704,9 +27634,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default to
- true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -28731,13 +27659,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation to
- know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -28762,13 +27686,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration documentation to
- know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
name:
type: string
@@ -28847,9 +27767,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
required:
- name
@@ -28910,9 +27828,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -28940,9 +27856,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -28995,9 +27909,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -29018,9 +27930,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -29033,9 +27943,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -29043,9 +27951,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -29070,14 +27976,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation
- to know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -29102,13 +28003,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -29117,19 +28014,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -29178,16 +28070,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -29223,9 +28111,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -29249,9 +28135,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -29303,6 +28187,7 @@ paths:
summary: Update a package policy
tags:
- Fleet package policies
+ x-beta: true
/api/fleet/package_policies/delete:
post:
operationId: post-fleet-package-policies-delete
@@ -29439,6 +28324,7 @@ paths:
summary: Bulk delete package policies
tags:
- Fleet package policies
+ x-beta: true
/api/fleet/package_policies/upgrade:
post:
description: Upgrade a package policy to a newer package version.
@@ -29520,6 +28406,7 @@ paths:
summary: Upgrade a package policy
tags:
- Fleet package policies
+ x-beta: true
/api/fleet/package_policies/upgrade/dryrun:
post:
operationId: post-fleet-package-policies-upgrade-dryrun
@@ -29718,9 +28605,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -29748,9 +28633,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -29803,9 +28686,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -29826,9 +28707,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -29841,9 +28720,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default
- to true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -29851,9 +28728,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -29878,15 +28753,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration
- documentation to know what streams are
- available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -29911,15 +28780,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are
- available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -29928,20 +28791,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should be
- used only in unusual circumstances and not as
- a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -29990,16 +28847,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will
- be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -30035,9 +28888,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -30061,10 +28912,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -30119,9 +28967,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -30149,9 +28995,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -30204,9 +29048,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -30227,9 +29069,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -30246,20 +29086,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should be
- used only in unusual circumstances and not as
- a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -30308,16 +29142,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will
- be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
vars:
@@ -30332,9 +29162,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- name
@@ -30369,6 +29197,7 @@ paths:
summary: Dry run a package policy upgrade
tags:
- Fleet package policies
+ x-beta: true
/api/fleet/proxies:
get:
operationId: get-fleet-proxies
@@ -30455,6 +29284,7 @@ paths:
summary: Get proxies
tags:
- Fleet proxies
+ x-beta: true
post:
operationId: post-fleet-proxies
parameters:
@@ -30572,6 +29402,7 @@ paths:
summary: Create a proxy
tags:
- Fleet proxies
+ x-beta: true
/api/fleet/proxies/{itemId}:
delete:
description: Delete a proxy by ID
@@ -30628,6 +29459,7 @@ paths:
summary: Delete a proxy
tags:
- Fleet proxies
+ x-beta: true
get:
description: Get a proxy by ID.
operationId: get-fleet-proxies-itemid
@@ -30708,6 +29540,7 @@ paths:
summary: Get a proxy
tags:
- Fleet proxies
+ x-beta: true
put:
description: Update a proxy by ID.
operationId: put-fleet-proxies-itemid
@@ -30828,6 +29661,7 @@ paths:
summary: Update a proxy
tags:
- Fleet proxies
+ x-beta: true
/api/fleet/service_tokens:
post:
operationId: post-fleet-service-tokens
@@ -30892,6 +29726,7 @@ paths:
summary: Create a service token
tags:
- Fleet service tokens
+ x-beta: true
/api/fleet/settings:
get:
operationId: get-fleet-settings
@@ -30987,6 +29822,7 @@ paths:
summary: Get settings
tags:
- Fleet internals
+ x-beta: true
put:
operationId: put-fleet-settings
parameters:
@@ -31119,6 +29955,7 @@ paths:
summary: Update settings
tags:
- Fleet internals
+ x-beta: true
/api/fleet/setup:
post:
operationId: post-fleet-setup
@@ -31144,11 +29981,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
additionalProperties: false
- description: >-
- A summary of the result of Fleet's `setup` lifecycle. If
- `isInitialized` is true, Fleet is ready to accept agent
- enrollment. `nonFatalErrors` may include useful insight into
- non-blocking issues with Fleet setup.
+ description: A summary of the result of Fleet's `setup` lifecycle. If `isInitialized` is true, Fleet is ready to accept agent enrollment. `nonFatalErrors` may include useful insight into non-blocking issues with Fleet setup.
type: object
properties:
isInitialized:
@@ -31200,6 +30033,7 @@ paths:
summary: Initiate Fleet setup
tags:
- Fleet internals
+ x-beta: true
/api/fleet/uninstall_tokens:
get:
description: List the metadata for the latest uninstall tokens per agent policy.
@@ -31300,6 +30134,7 @@ paths:
summary: Get metadata for latest uninstall tokens
tags:
- Fleet uninstall tokens
+ x-beta: true
/api/fleet/uninstall_tokens/{uninstallTokenId}:
get:
description: Get one decrypted uninstall token by its ID.
@@ -31371,6 +30206,7 @@ paths:
summary: Get a decrypted uninstall token
tags:
- Fleet uninstall tokens
+ x-beta: true
/api/lists:
delete:
description: |
@@ -31409,8 +30245,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31440,6 +30275,7 @@ paths:
summary: Delete a list
tags:
- Security Lists API
+ x-beta: true
get:
description: Get the details of a list using the list ID.
operationId: ReadList
@@ -31462,8 +30298,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31493,6 +30328,7 @@ paths:
summary: Get list details
tags:
- Security Lists API
+ x-beta: true
patch:
description: Update specific fields of an existing list using the list ID.
operationId: PatchList
@@ -31531,8 +30367,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31562,6 +30397,7 @@ paths:
summary: Patch a list
tags:
- Security Lists API
+ x-beta: true
post:
description: Create a new list.
operationId: CreateList
@@ -31607,8 +30443,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31638,13 +30473,11 @@ paths:
summary: Create a list
tags:
- Security Lists API
+ x-beta: true
put:
- description: >
- Update a list using the list ID. The original list is replaced, and all
- unspecified fields are deleted.
-
+ description: |
+ Update a list using the list ID. The original list is replaced, and all unspecified fields are deleted.
> info
-
> You cannot modify the `id` value.
operationId: UpdateList
requestBody:
@@ -31684,8 +30517,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31715,11 +30547,10 @@ paths:
summary: Update a list
tags:
- Security Lists API
+ x-beta: true
/api/lists/_find:
get:
- description: >-
- Get a paginated subset of lists. By default, the first page is returned,
- with 20 results per page.
+ description: Get a paginated subset of lists. By default, the first page is returned, with 20 results per page.
operationId: FindLists
parameters:
- description: The page number to return
@@ -31749,24 +30580,17 @@ paths:
- desc
- asc
type: string
- - description: >
- Returns the list that come after the last list 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.
+ - description: |
+ Returns the list that come after the last list 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.
in: query
name: cursor
required: false
schema:
$ref: '#/components/schemas/Security_Lists_API_FindListsCursor'
- - description: >
- Filters the returned results according to the value of the specified
- field,
-
+ - description: |
+ Filters the returned results according to the value of the specified field,
using the : syntax.
in: query
name: filter
@@ -31807,8 +30631,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31832,6 +30655,7 @@ paths:
summary: Get lists
tags:
- Security Lists API
+ x-beta: true
/api/lists/index:
delete:
description: Delete the `.lists` and `.items` data streams.
@@ -31853,8 +30677,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31884,6 +30707,7 @@ paths:
summary: Delete list data streams
tags:
- Security Lists API
+ x-beta: true
get:
description: Verify that `.lists` and `.items` data streams exist.
operationId: ReadListIndex
@@ -31907,8 +30731,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31938,6 +30761,7 @@ paths:
summary: Get status of list data streams
tags:
- Security Lists API
+ x-beta: true
post:
description: Create `.lists` and `.items` data streams in the relevant space.
operationId: CreateListIndex
@@ -31958,8 +30782,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -31989,6 +30812,7 @@ paths:
summary: Create list data streams
tags:
- Security Lists API
+ x-beta: true
/api/lists/items:
delete:
description: Delete a list item using its `id`, or its `list_id` and `value` fields.
@@ -32012,9 +30836,7 @@ paths:
required: false
schema:
type: string
- - description: >-
- Determines when changes made by the request are made visible to
- search
+ - description: Determines when changes made by the request are made visible to search
in: query
name: refresh
required: false
@@ -32041,8 +30863,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32072,6 +30893,7 @@ paths:
summary: Delete a list item
tags:
- Security Lists API
+ x-beta: true
get:
description: Get the details of a list item.
operationId: ReadListItem
@@ -32110,8 +30932,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32141,6 +30962,7 @@ paths:
summary: Get a list item
tags:
- Security Lists API
+ x-beta: true
patch:
description: Update specific fields of an existing list item using the list item ID.
operationId: PatchListItem
@@ -32157,9 +30979,7 @@ paths:
meta:
$ref: '#/components/schemas/Security_Lists_API_ListItemMetadata'
refresh:
- description: >-
- Determines when changes made by the request are made visible
- to search
+ description: Determines when changes made by the request are made visible to search
enum:
- 'true'
- 'false'
@@ -32183,8 +31003,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32214,16 +31033,13 @@ paths:
summary: Patch a list item
tags:
- Security Lists API
+ x-beta: true
post:
- description: >
+ description: |
Create a list item and associate it with the specified list.
-
- All list items in the same list must be the same type. For example, each
- list item in an `ip` list must define a specific IP address.
-
+ All list items in the same list must be the same type. For example, each list item in an `ip` list must define a specific IP address.
> info
-
> Before creating a list item, you must create a list.
operationId: CreateListItem
requestBody:
@@ -32239,9 +31055,7 @@ paths:
meta:
$ref: '#/components/schemas/Security_Lists_API_ListItemMetadata'
refresh:
- description: >-
- Determines when changes made by the request are made visible
- to search
+ description: Determines when changes made by the request are made visible to search
enum:
- 'true'
- 'false'
@@ -32266,8 +31080,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32297,13 +31110,11 @@ paths:
summary: Create a list item
tags:
- Security Lists API
+ x-beta: true
put:
- description: >
- Update a list item using the list item ID. The original list item is
- replaced, and all unspecified fields are deleted.
-
+ description: |
+ Update a list item using the list item ID. The original list item is replaced, and all unspecified fields are deleted.
> info
-
> You cannot modify the `id` value.
operationId: UpdateListItem
requestBody:
@@ -32337,8 +31148,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32368,6 +31178,7 @@ paths:
summary: Update a list item
tags:
- Security Lists API
+ x-beta: true
/api/lists/items/_export:
post:
description: Export list item values from the specified list.
@@ -32393,8 +31204,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32424,6 +31234,7 @@ paths:
summary: Export list items
tags:
- Security Lists API
+ x-beta: true
/api/lists/items/_find:
get:
description: Get all list items in the specified list.
@@ -32462,24 +31273,17 @@ paths:
- desc
- asc
type: string
- - description: >
- Returns the list that come after the last list 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.
+ - description: |
+ Returns the list that come after the last list 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.
in: query
name: cursor
required: false
schema:
$ref: '#/components/schemas/Security_Lists_API_FindListItemsCursor'
- - description: >
- Filters the returned results according to the value of the specified
- field,
-
+ - description: |
+ Filters the returned results according to the value of the specified field,
using the : syntax.
in: query
name: filter
@@ -32494,8 +31298,7 @@ paths:
type: object
properties:
cursor:
- $ref: >-
- #/components/schemas/Security_Lists_API_FindListItemsCursor
+ $ref: '#/components/schemas/Security_Lists_API_FindListItemsCursor'
data:
items:
$ref: '#/components/schemas/Security_Lists_API_ListItem'
@@ -32521,8 +31324,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32546,12 +31348,11 @@ paths:
summary: Get list items
tags:
- Security Lists API
+ x-beta: true
/api/lists/items/_import:
post:
- description: >
- Import list items from a TXT or CSV file. The maximum file size is 9
- million bytes.
-
+ description: |
+ Import list items from a TXT or CSV file. The maximum file size is 9 million bytes.
You can import items to a new or existing list.
operationId: ImportListItems
@@ -32565,12 +31366,10 @@ paths:
required: false
schema:
$ref: '#/components/schemas/Security_Lists_API_ListId'
- - description: >
+ - description: |
Type of the importing list.
-
- Required when importing a new list that is `list_id` is not
- specified.
+ Required when importing a new list that is `list_id` is not specified.
in: query
name: type
required: false
@@ -32586,9 +31385,7 @@ paths:
required: false
schema:
type: string
- - description: >-
- Determines when changes made by the request are made visible to
- search
+ - description: Determines when changes made by the request are made visible to search
in: query
name: refresh
required: false
@@ -32605,9 +31402,7 @@ paths:
type: object
properties:
file:
- description: >-
- A `.txt` or `.csv` file containing newline separated list
- items
+ description: A `.txt` or `.csv` file containing newline separated list items
format: binary
type: string
required: true
@@ -32623,8 +31418,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32654,6 +31448,7 @@ paths:
summary: Import list items
tags:
- Security Lists API
+ x-beta: true
/api/lists/privileges:
get:
operationId: ReadListPrivileges
@@ -32680,8 +31475,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -32705,12 +31499,11 @@ paths:
summary: Get list privileges
tags:
- Security Lists API
+ x-beta: true
/api/ml/saved_objects/sync:
get:
- description: >
- Synchronizes Kibana saved objects for machine learning jobs and trained
- models. This API runs automatically when you start Kibana and
- periodically thereafter.
+ description: |
+ Synchronizes Kibana saved objects for machine learning jobs and trained models. This API runs automatically when you start Kibana and periodically thereafter.
operationId: mlSync
parameters:
- $ref: '#/components/parameters/Machine_learning_APIs_simulateParam'
@@ -32733,6 +31526,7 @@ paths:
summary: Sync machine learning saved objects
tags:
- ml
+ x-beta: true
/api/note:
delete:
description: Delete a note from a Timeline using the note ID.
@@ -32774,7 +31568,7 @@ paths:
summary: Delete a note
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
get:
description: Get all notes for a given document.
operationId: GetNotes
@@ -32838,7 +31632,7 @@ paths:
summary: Get notes
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
patch:
description: Add a note to a Timeline or update an existing note.
operationId: PersistNoteRoute
@@ -32883,8 +31677,7 @@ paths:
type: object
properties:
persistNote:
- $ref: >-
- #/components/schemas/Security_Timeline_API_ResponseNote
+ $ref: '#/components/schemas/Security_Timeline_API_ResponseNote'
required:
- persistNote
required:
@@ -32893,7 +31686,7 @@ paths:
summary: Add or update a note
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/osquery/live_queries:
get:
description: Get a list of all live queries.
@@ -32903,19 +31696,18 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_FindLiveQueryRequestQuery
+ $ref: '#/components/schemas/Security_Osquery_API_FindLiveQueryRequestQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get live queries
tags:
- Security Osquery API
+ x-beta: true
post:
description: Create and run a live query.
operationId: OsqueryCreateLiveQuery
@@ -32923,20 +31715,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_CreateLiveQueryRequestBody
+ $ref: '#/components/schemas/Security_Osquery_API_CreateLiveQueryRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Create a live query
tags:
- Security Osquery API
+ x-beta: true
/api/osquery/live_queries/{id}:
get:
description: Get the details of a live query using the query ID.
@@ -32957,12 +31748,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get live query details
tags:
- Security Osquery API
+ x-beta: true
/api/osquery/live_queries/{id}/results/{actionId}:
get:
description: Get the results of a live query using the query action ID.
@@ -32982,19 +31773,18 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_GetLiveQueryResultsRequestQuery
+ $ref: '#/components/schemas/Security_Osquery_API_GetLiveQueryResultsRequestQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get live query results
tags:
- Security Osquery API
+ x-beta: true
/api/osquery/packs:
get:
description: Get a list of all query packs.
@@ -33010,12 +31800,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get packs
tags:
- Security Osquery API
+ x-beta: true
post:
description: Create a query pack.
operationId: OsqueryCreatePacks
@@ -33030,12 +31820,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Create a pack
tags:
- Security Osquery API
+ x-beta: true
/api/osquery/packs/{id}:
delete:
description: Delete a query pack using the pack ID.
@@ -33051,12 +31841,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Delete a pack
tags:
- Security Osquery API
+ x-beta: true
get:
description: Get the details of a query pack using the pack ID.
operationId: OsqueryGetPacksDetails
@@ -33071,12 +31861,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get pack details
tags:
- Security Osquery API
+ x-beta: true
put:
description: |
Update a query pack using the pack ID.
@@ -33100,12 +31890,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Update a pack
tags:
- Security Osquery API
+ x-beta: true
/api/osquery/saved_queries:
get:
description: Get a list of all saved queries.
@@ -33115,19 +31905,18 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_FindSavedQueryRequestQuery
+ $ref: '#/components/schemas/Security_Osquery_API_FindSavedQueryRequestQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get saved queries
tags:
- Security Osquery API
+ x-beta: true
post:
description: Create and run a saved query.
operationId: OsqueryCreateSavedQuery
@@ -33135,20 +31924,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_CreateSavedQueryRequestBody
+ $ref: '#/components/schemas/Security_Osquery_API_CreateSavedQueryRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Create a saved query
tags:
- Security Osquery API
+ x-beta: true
/api/osquery/saved_queries/{id}:
delete:
description: Delete a saved query using the query ID.
@@ -33164,12 +31952,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Delete a saved query
tags:
- Security Osquery API
+ x-beta: true
get:
description: Get the details of a saved query using the query ID.
operationId: OsqueryGetSavedQueryDetails
@@ -33184,12 +31972,12 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get saved query details
tags:
- Security Osquery API
+ x-beta: true
put:
description: |
Update a saved query using the query ID.
@@ -33206,20 +31994,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_UpdateSavedQueryRequestBody
+ $ref: '#/components/schemas/Security_Osquery_API_UpdateSavedQueryRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Update a saved query
tags:
- Security Osquery API
+ x-beta: true
/api/pinned_event:
patch:
description: Pin an event to an existing Timeline.
@@ -33253,8 +32040,7 @@ paths:
type: object
properties:
persistPinnedEventOnTimeline:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistPinnedEventResponse
+ $ref: '#/components/schemas/Security_Timeline_API_PersistPinnedEventResponse'
required:
- persistPinnedEventOnTimeline
required:
@@ -33263,12 +32049,10 @@ paths:
summary: Pin an event
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/risk_score/engine/dangerously_delete_data:
delete:
- description: >-
- Cleaning up the the Risk Engine by removing the indices, mapping and
- transforms
+ description: Cleaning up the the Risk Engine by removing the indices, mapping and transforms
operationId: CleanUpRiskEngine
responses:
'200':
@@ -33284,25 +32068,21 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_TaskManagerUnavailableResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_TaskManagerUnavailableResponse'
description: Task manager is unavailable
default:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_CleanUpRiskEngineErrorResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_CleanUpRiskEngineErrorResponse'
description: Unexpected error
summary: Cleanup the Risk Engine
tags:
- Security Entity Analytics API
+ x-beta: true
/api/risk_score/engine/schedule_now:
post:
- description: >-
- Schedule the risk scoring engine to run as soon as possible. You can use
- this to recalculate entity risk scores after updating their asset
- criticality.
+ description: Schedule the risk scoring engine to run as soon as possible. You can use this to recalculate entity risk scores after updating their asset criticality.
operationId: ScheduleRiskEngineNow
requestBody:
content:
@@ -33312,46 +32092,35 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_RiskEngineScheduleNowResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_RiskEngineScheduleNowResponse'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_TaskManagerUnavailableResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_TaskManagerUnavailableResponse'
description: Task manager is unavailable
default:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_RiskEngineScheduleNowErrorResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_RiskEngineScheduleNowErrorResponse'
description: Unexpected error
summary: Run the risk scoring engine
tags:
- Security Entity Analytics API
+ x-beta: true
/api/saved_objects/_export:
post:
- description: >
+ description: |
Retrieve sets of saved objects that you want to import into Kibana.
-
You must include `type` or `objects` in the request body.
+ Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
- Exported saved objects are not backwards compatible and cannot be
- imported into an older version of Kibana.
-
+ NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.
- NOTE: The `savedObjects.maxImportExportSize` configuration setting
- limits the number of saved objects which may be exported.
-
-
- This functionality is in technical preview and may be changed or removed
- in a future release. Elastic will work to fix any issues, but features
- in technical preview are not subject to the support SLA of official GA
- features.
+ This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
operationId: exportSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Serverless_saved_objects_kbn_xsrf'
@@ -33360,8 +32129,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
examples:
exportSavedObjectsRequest:
- $ref: >-
- #/components/examples/Serverless_saved_objects_export_objects_request
+ $ref: '#/components/examples/Serverless_saved_objects_export_objects_request'
schema:
type: object
properties:
@@ -33370,9 +32138,7 @@ paths:
description: Do not add export details entry at the end of the stream.
type: boolean
includeReferencesDeep:
- description: >-
- Includes all of the referenced objects in the exported
- objects.
+ description: Includes all of the referenced objects in the exported objects.
type: boolean
objects:
description: A list of objects to export.
@@ -33380,9 +32146,7 @@ paths:
type: object
type: array
type:
- description: >-
- The saved object types to include in the export. Use `*` to
- export all the types.
+ description: The saved object types to include in the export. Use `*` to export all the types.
oneOf:
- type: string
- items:
@@ -33395,8 +32159,7 @@ paths:
application/x-ndjson; Elastic-Api-Version=2023-10-31:
examples:
exportSavedObjectsResponse:
- $ref: >-
- #/components/examples/Serverless_saved_objects_export_objects_response
+ $ref: '#/components/examples/Serverless_saved_objects_export_objects_response'
schema:
additionalProperties: true
type: object
@@ -33410,51 +32173,33 @@ paths:
summary: Export saved objects
tags:
- saved objects
+ x-beta: true
/api/saved_objects/_import:
post:
- description: >
- Create sets of Kibana saved objects from a file created by the export
- API.
-
- Saved objects can be imported only into the same version, a newer minor
- on the same major, or the next major. Exported saved objects are not
- backwards compatible and cannot be imported into an older version of
- Kibana.
-
+ description: |
+ Create sets of Kibana saved objects from a file created by the export API.
+ Saved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
- This functionality is in technical preview and may be changed or removed
- in a future release. Elastic will work to fix any issues, but features
- in technical preview are not subject to the support SLA of official GA
- features.
+ This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
operationId: importSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Serverless_saved_objects_kbn_xsrf'
- - description: >
- 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.
+ - description: |
+ 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.
in: query
name: createNewCopies
required: false
schema:
type: boolean
- - description: >
- 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.
+ - description: |
+ 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.
in: query
name: overwrite
required: false
schema:
type: boolean
- - description: >
- 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.
+ - description: |
+ 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.
in: query
name: compatibilityMode
required: false
@@ -33465,19 +32210,13 @@ paths:
multipart/form-data; Elastic-Api-Version=2023-10-31:
examples:
importObjectsRequest:
- $ref: >-
- #/components/examples/Serverless_saved_objects_import_objects_request
+ $ref: '#/components/examples/Serverless_saved_objects_import_objects_request'
schema:
type: object
properties:
file:
- description: >
- A file exported using the export API. NOTE: The
- `savedObjects.maxImportExportSize` configuration setting
- limits the number of saved objects which may be included in
- this file. Similarly, the
- `savedObjects.maxImportPayloadBytes` setting limits the
- overall size of the file that can be imported.
+ description: |
+ A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
required: true
responses:
'200':
@@ -33485,44 +32224,30 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
examples:
importObjectsResponse:
- $ref: >-
- #/components/examples/Serverless_saved_objects_import_objects_response
+ $ref: '#/components/examples/Serverless_saved_objects_import_objects_response'
schema:
type: object
properties:
errors:
- description: >
- Indicates the import was unsuccessful and specifies the
- objects that failed to import.
-
+ description: |
+ Indicates the import was unsuccessful and specifies the objects that failed to import.
- NOTE: One object may result in multiple errors, which
- requires separate steps to resolve. For instance, a
- `missing_references` error and conflict error.
+ NOTE: One object may result in multiple errors, which requires separate steps to resolve. For instance, a `missing_references` error and conflict error.
items:
type: object
type: array
success:
- description: >
- Indicates when the import was successfully completed. When
- set to false, some objects may not have been created. For
- additional information, refer to the `errors` and
- `successResults` properties.
+ description: |
+ Indicates when the import was successfully completed. When set to false, some objects may not have been created. For additional information, refer to the `errors` and `successResults` properties.
type: boolean
successCount:
description: Indicates the number of successfully imported records.
type: integer
successResults:
- description: >
- Indicates the objects that are successfully imported, with
- any metadata if applicable.
+ description: |
+ Indicates the objects that are successfully imported, with any metadata if applicable.
-
- NOTE: Objects are created only when all resolvable errors
- are addressed, including conflicts and missing references.
- If objects are created as new copies, each entry in the
- `successResults` array includes a `destinationId`
- attribute.
+ NOTE: Objects are created only when all resolvable errors are addressed, including conflicts and missing references. If objects are created as new copies, each entry in the `successResults` array includes a `destinationId` attribute.
items:
type: object
type: array
@@ -33544,12 +32269,10 @@ paths:
-X POST api/saved_objects/_import?createNewCopies=true
-H "kbn-xsrf: true"
--form file=@file.ndjson
+ x-beta: true
/api/security_ai_assistant/anonymization_fields/_bulk_action:
post:
- description: >-
- Apply a bulk action to multiple anonymization fields. The bulk action is
- applied to all anonymization fields that match the filter or to the list
- of anonymization fields by their IDs.
+ description: Apply a bulk action to multiple anonymization fields. The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs.
operationId: PerformAnonymizationFieldsBulkAction
requestBody:
content:
@@ -33559,8 +32282,7 @@ paths:
properties:
create:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldCreateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldCreateProps'
type: array
delete:
type: object
@@ -33576,16 +32298,14 @@ paths:
type: string
update:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldUpdateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldUpdateProps'
type: array
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResponse'
description: Indicates a successful call.
'400':
content:
@@ -33603,7 +32323,7 @@ paths:
summary: Apply a bulk action to anonymization fields
tags:
- Security AI Assistant API
- - Bulk API
+ x-beta: true
/api/security_ai_assistant/anonymization_fields/_find:
get:
description: Get a list of all anonymization fields.
@@ -33627,8 +32347,7 @@ paths:
name: sort_field
required: false
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_FindAnonymizationFieldsSortField
+ $ref: '#/components/schemas/Security_AI_Assistant_API_FindAnonymizationFieldsSortField'
- description: Sort order
in: query
name: sort_order
@@ -33660,8 +32379,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse'
type: array
page:
type: integer
@@ -33691,7 +32409,7 @@ paths:
summary: Get anonymization fields
tags:
- Security AI Assistant API
- - AnonymizationFields API
+ x-beta: true
/api/security_ai_assistant/chat/complete:
post:
description: Create a model response for the given chat conversation.
@@ -33726,7 +32444,7 @@ paths:
summary: Create a model response
tags:
- Security AI Assistant API
- - Chat Complete API
+ x-beta: true
/api/security_ai_assistant/current_user/conversations:
post:
description: Create a new Security AI Assistant conversation.
@@ -33735,16 +32453,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationCreateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationCreateProps'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
description: Indicates a successful call.
'400':
content:
@@ -33762,7 +32478,7 @@ paths:
summary: Create a conversation
tags:
- Security AI Assistant API
- - Conversation API
+ x-beta: true
/api/security_ai_assistant/current_user/conversations/_find:
get:
description: Get a list of all conversations for the current user.
@@ -33786,8 +32502,7 @@ paths:
name: sort_field
required: false
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_FindConversationsSortField
+ $ref: '#/components/schemas/Security_AI_Assistant_API_FindConversationsSortField'
- description: Sort order
in: query
name: sort_order
@@ -33819,8 +32534,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
type: array
page:
type: integer
@@ -33850,7 +32564,7 @@ paths:
summary: Get conversations
tags:
- Security AI Assistant API
- - Conversations API
+ x-beta: true
/api/security_ai_assistant/current_user/conversations/{id}:
delete:
description: Delete an existing conversation using the conversation ID.
@@ -33867,8 +32581,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
description: Indicates a successful call.
'400':
content:
@@ -33886,7 +32599,7 @@ paths:
summary: Delete a conversation
tags:
- Security AI Assistant API
- - Conversation API
+ x-beta: true
get:
description: Get the details of an existing conversation using the conversation ID.
operationId: ReadConversation
@@ -33902,8 +32615,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
description: Indicates a successful call.
'400':
content:
@@ -33921,7 +32633,7 @@ paths:
summary: Get a conversation
tags:
- Security AI Assistant API
- - Conversations API
+ x-beta: true
put:
description: Update an existing conversation using the conversation ID.
operationId: UpdateConversation
@@ -33936,16 +32648,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationUpdateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationUpdateProps'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
description: Indicates a successful call.
'400':
content:
@@ -33963,13 +32673,10 @@ paths:
summary: Update a conversation
tags:
- Security AI Assistant API
- - Conversation API
+ x-beta: true
/api/security_ai_assistant/prompts/_bulk_action:
post:
- description: >-
- Apply a bulk action to multiple prompts. The bulk action is applied to
- all prompts that match the filter or to the list of prompts by their
- IDs.
+ description: Apply a bulk action to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs.
operationId: PerformPromptsBulkAction
requestBody:
content:
@@ -33979,8 +32686,7 @@ paths:
properties:
create:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptCreateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptCreateProps'
type: array
delete:
type: object
@@ -33996,16 +32702,14 @@ paths:
type: string
update:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptUpdateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptUpdateProps'
type: array
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptsBulkCrudActionResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptsBulkCrudActionResponse'
description: Indicates a successful call.
'400':
content:
@@ -34023,7 +32727,7 @@ paths:
summary: Apply a bulk action to prompts
tags:
- Security AI Assistant API
- - Bulk API
+ x-beta: true
/api/security_ai_assistant/prompts/_find:
get:
description: Get a list of all prompts.
@@ -34047,8 +32751,7 @@ paths:
name: sort_field
required: false
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_FindPromptsSortField
+ $ref: '#/components/schemas/Security_AI_Assistant_API_FindPromptsSortField'
- description: Sort order
in: query
name: sort_order
@@ -34080,8 +32783,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptResponse'
type: array
page:
type: integer
@@ -34111,7 +32813,7 @@ paths:
summary: Get prompts
tags:
- Security AI Assistant API
- - Prompts API
+ x-beta: true
/api/security/role:
get:
operationId: get-security-role
@@ -34124,10 +32826,7 @@ paths:
enum:
- '2023-10-31'
type: string
- - description: >-
- 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.
+ - description: 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.
in: query
name: replaceDeprecatedPrivileges
required: false
@@ -34139,6 +32838,7 @@ paths:
summary: Get all roles
tags:
- roles
+ x-beta: true
/api/security/role/{name}:
delete:
operationId: delete-security-role-name
@@ -34170,6 +32870,7 @@ paths:
summary: Delete a role
tags:
- roles
+ x-beta: true
get:
operationId: get-security-role-name
parameters:
@@ -34188,10 +32889,7 @@ paths:
schema:
minLength: 1
type: string
- - description: >-
- 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.
+ - description: 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.
in: query
name: replaceDeprecatedPrivileges
required: false
@@ -34203,10 +32901,9 @@ paths:
summary: Get a role
tags:
- roles
+ x-beta: true
put:
- description: >-
- Create a new Kibana role or update the attributes of an existing role.
- Kibana roles are stored in the Elasticsearch native realm.
+ description: Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm.
operationId: put-security-role-name
parameters:
- description: The version of the API to use
@@ -34256,9 +32953,7 @@ paths:
properties:
cluster:
items:
- description: >-
- Cluster privileges that define the cluster level
- actions that users can perform.
+ description: Cluster privileges that define the cluster level actions that users can perform.
type: string
type: array
indices:
@@ -34267,55 +32962,29 @@ paths:
type: object
properties:
allow_restricted_indices:
- description: >-
- Restricted indices are a special category of
- indices that are used internally to store
- configuration data and should not be directly
- accessed. Only internal system roles should
- normally grant privileges over the restricted
- indices. Toggling this flag is very strongly
- discouraged because it could effectively grant
- unrestricted operations on critical data, making
- the entire system unstable or leaking sensitive
- information. If for administrative purposes you
- need to create a role with privileges covering
- restricted indices, however, you can set this
- property to true. In that case, the names field
- covers the restricted indices too.
+ description: Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field covers the restricted indices too.
type: boolean
field_security:
additionalProperties:
items:
- description: >-
- The document fields that the role members have
- read access to.
+ description: The document fields that the role members have read access to.
type: string
type: array
type: object
names:
items:
- description: >-
- The data streams, indices, and aliases to which
- the permissions in this entry apply. It supports
- wildcards (*).
+ description: The data streams, indices, and aliases to which the permissions in this entry apply. It supports wildcards (*).
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The index level privileges that the role members
- have for the data streams and indices.
+ description: The index level privileges that the role members have for the data streams and indices.
type: string
minItems: 1
type: array
query:
- description: >-
- A search query that defines the documents the role
- members have read access to. A document within the
- specified data streams and indices must match this
- query in order for it to be accessible by the role
- members.
+ description: A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members.
type: string
required:
- names
@@ -34328,19 +32997,13 @@ paths:
properties:
clusters:
items:
- description: >-
- A list of remote cluster aliases. It supports
- literal strings as well as wildcards and regular
- expressions.
+ description: A list of remote cluster aliases. It supports literal strings as well as wildcards and regular expressions.
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The cluster level privileges for the remote
- cluster. The allowed values are a subset of the
- cluster privileges.
+ description: The cluster level privileges for the remote cluster. The allowed values are a subset of the cluster privileges.
type: string
minItems: 1
type: array
@@ -34354,64 +33017,35 @@ paths:
type: object
properties:
allow_restricted_indices:
- description: >-
- Restricted indices are a special category of
- indices that are used internally to store
- configuration data and should not be directly
- accessed. Only internal system roles should
- normally grant privileges over the restricted
- indices. Toggling this flag is very strongly
- discouraged because it could effectively grant
- unrestricted operations on critical data, making
- the entire system unstable or leaking sensitive
- information. If for administrative purposes you
- need to create a role with privileges covering
- restricted indices, however, you can set this
- property to true. In that case, the names field
- will cover the restricted indices too.
+ description: Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field will cover the restricted indices too.
type: boolean
clusters:
items:
- description: >-
- A list of remote cluster aliases. It supports
- literal strings as well as wildcards and regular
- expressions.
+ description: A list of remote cluster aliases. It supports literal strings as well as wildcards and regular expressions.
type: string
minItems: 1
type: array
field_security:
additionalProperties:
items:
- description: >-
- The document fields that the role members have
- read access to.
+ description: The document fields that the role members have read access to.
type: string
type: array
type: object
names:
items:
- description: >-
- A list of remote aliases, data streams, or
- indices to which the permissions apply. It
- supports wildcards (*).
+ description: A list of remote aliases, data streams, or indices to which the permissions apply. It supports wildcards (*).
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The index level privileges that role members
- have for the specified indices.
+ description: The index level privileges that role members have for the specified indices.
type: string
minItems: 1
type: array
query:
- description: >-
- A search query that defines the documents the role
- members have read access to. A document within the
- specified data streams and indices must match this
- query in order for it to be accessible by the role
- members.
+ description: 'A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members. '
type: string
required:
- clusters
@@ -34439,23 +33073,17 @@ paths:
nullable: true
oneOf:
- items:
- description: >-
- A base privilege that grants applies to all
- spaces.
+ description: A base privilege that grants applies to all spaces.
type: string
type: array
- items:
- description: >-
- A base privilege that applies to specific
- spaces.
+ description: A base privilege that applies to specific spaces.
type: string
type: array
feature:
additionalProperties:
items:
- description: >-
- The privileges that the role member has for the
- feature.
+ description: The privileges that the role member has for the feature.
type: string
type: array
type: object
@@ -34488,6 +33116,7 @@ paths:
summary: Create or update a role
tags:
- roles
+ x-beta: true
/api/security/roles:
post:
operationId: post-security-roles
@@ -34529,9 +33158,7 @@ paths:
properties:
cluster:
items:
- description: >-
- Cluster privileges that define the cluster level
- actions that users can perform.
+ description: Cluster privileges that define the cluster level actions that users can perform.
type: string
type: array
indices:
@@ -34540,58 +33167,29 @@ paths:
type: object
properties:
allow_restricted_indices:
- description: >-
- Restricted indices are a special category of
- indices that are used internally to store
- configuration data and should not be
- directly accessed. Only internal system
- roles should normally grant privileges over
- the restricted indices. Toggling this flag
- is very strongly discouraged because it
- could effectively grant unrestricted
- operations on critical data, making the
- entire system unstable or leaking sensitive
- information. If for administrative purposes
- you need to create a role with privileges
- covering restricted indices, however, you
- can set this property to true. In that case,
- the names field covers the restricted
- indices too.
+ description: Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field covers the restricted indices too.
type: boolean
field_security:
additionalProperties:
items:
- description: >-
- The document fields that the role
- members have read access to.
+ description: The document fields that the role members have read access to.
type: string
type: array
type: object
names:
items:
- description: >-
- The data streams, indices, and aliases to
- which the permissions in this entry apply.
- It supports wildcards (*).
+ description: The data streams, indices, and aliases to which the permissions in this entry apply. It supports wildcards (*).
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The index level privileges that the role
- members have for the data streams and
- indices.
+ description: The index level privileges that the role members have for the data streams and indices.
type: string
minItems: 1
type: array
query:
- description: >-
- A search query that defines the documents
- the role members have read access to. A
- document within the specified data streams
- and indices must match this query in order
- for it to be accessible by the role members.
+ description: A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members.
type: string
required:
- names
@@ -34604,19 +33202,13 @@ paths:
properties:
clusters:
items:
- description: >-
- A list of remote cluster aliases. It
- supports literal strings as well as
- wildcards and regular expressions.
+ description: A list of remote cluster aliases. It supports literal strings as well as wildcards and regular expressions.
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The cluster level privileges for the
- remote cluster. The allowed values are a
- subset of the cluster privileges.
+ description: The cluster level privileges for the remote cluster. The allowed values are a subset of the cluster privileges.
type: string
minItems: 1
type: array
@@ -34630,67 +33222,35 @@ paths:
type: object
properties:
allow_restricted_indices:
- description: >-
- Restricted indices are a special category of
- indices that are used internally to store
- configuration data and should not be
- directly accessed. Only internal system
- roles should normally grant privileges over
- the restricted indices. Toggling this flag
- is very strongly discouraged because it
- could effectively grant unrestricted
- operations on critical data, making the
- entire system unstable or leaking sensitive
- information. If for administrative purposes
- you need to create a role with privileges
- covering restricted indices, however, you
- can set this property to true. In that case,
- the names field will cover the restricted
- indices too.
+ description: Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field will cover the restricted indices too.
type: boolean
clusters:
items:
- description: >-
- A list of remote cluster aliases. It
- supports literal strings as well as
- wildcards and regular expressions.
+ description: A list of remote cluster aliases. It supports literal strings as well as wildcards and regular expressions.
type: string
minItems: 1
type: array
field_security:
additionalProperties:
items:
- description: >-
- The document fields that the role
- members have read access to.
+ description: The document fields that the role members have read access to.
type: string
type: array
type: object
names:
items:
- description: >-
- A list of remote aliases, data streams, or
- indices to which the permissions apply. It
- supports wildcards (*).
+ description: A list of remote aliases, data streams, or indices to which the permissions apply. It supports wildcards (*).
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The index level privileges that role
- members have for the specified indices.
+ description: The index level privileges that role members have for the specified indices.
type: string
minItems: 1
type: array
query:
- description: >-
- A search query that defines the documents
- the role members have read access to. A
- document within the specified data streams
- and indices must match this query in order
- for it to be accessible by the role
- members.
+ description: 'A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members. '
type: string
required:
- clusters
@@ -34699,9 +33259,7 @@ paths:
type: array
run_as:
items:
- description: >-
- A user name that the role member can
- impersonate.
+ description: A user name that the role member can impersonate.
type: string
type: array
kibana:
@@ -34720,23 +33278,17 @@ paths:
nullable: true
oneOf:
- items:
- description: >-
- A base privilege that grants applies to
- all spaces.
+ description: A base privilege that grants applies to all spaces.
type: string
type: array
- items:
- description: >-
- A base privilege that applies to specific
- spaces.
+ description: A base privilege that applies to specific spaces.
type: string
type: array
feature:
additionalProperties:
items:
- description: >-
- The privileges that the role member has for
- the feature.
+ description: The privileges that the role member has for the feature.
type: string
type: array
type: object
@@ -34772,6 +33324,7 @@ paths:
summary: Create or update roles
tags:
- roles
+ x-beta: true
/api/spaces/space:
get:
operationId: get-spaces-space
@@ -34784,9 +33337,7 @@ paths:
enum:
- '2023-10-31'
type: string
- - description: >-
- Specifies which authorization checks are applied to the API call.
- The default value is `any`.
+ - description: Specifies which authorization checks are applied to the API call. The default value is `any`.
in: query
name: purpose
required: false
@@ -34796,14 +33347,7 @@ paths:
- copySavedObjectsIntoSpace
- shareSavedObjectsIntoSpace
type: string
- - description: >-
- 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.
+ - description: 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.
in: query
name: include_authorized_purposes
required: true
@@ -34826,9 +33370,17 @@ paths:
responses:
'200':
description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getSpacesResponseExample1:
+ $ref: '#/components/examples/get_spaces_response1'
+ getSpacesResponseExample2:
+ $ref: '#/components/examples/get_spaces_response2'
summary: Get all spaces
tags:
- spaces
+ x-beta: true
post:
operationId: post-spaces-space
parameters:
@@ -34857,10 +33409,7 @@ paths:
_reserved:
type: boolean
color:
- description: >-
- The hexadecimal color code used in the space avatar. By
- default, the color is automatically generated from the space
- name.
+ description: The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
type: string
description:
description: A description for the space.
@@ -34872,26 +33421,13 @@ paths:
type: string
type: array
id:
- description: >-
- 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.
+ description: 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.
type: string
imageUrl:
- description: >-
- 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.
+ description: 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.
type: string
initials:
- description: >-
- One or two characters that are shown in the space avatar. By
- default, the initials are automatically generated from the
- space name.
+ description: One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.
maxLength: 2
type: string
name:
@@ -34901,17 +33437,19 @@ paths:
required:
- id
- name
+ examples:
+ createSpaceRequest:
+ $ref: '#/components/examples/create_space_request'
responses:
'200':
description: Indicates a successful call.
summary: Create a space
tags:
- spaces
+ x-beta: true
/api/spaces/space/{id}:
delete:
- description: >-
- When you delete a space, all saved objects that belong to the space are
- automatically deleted, which is permanent and cannot be undone.
+ description: When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone.
operationId: delete-spaces-space-id
parameters:
- description: The version of the API to use
@@ -34943,6 +33481,7 @@ paths:
summary: Delete a space
tags:
- spaces
+ x-beta: true
get:
operationId: get-spaces-space-id
parameters:
@@ -34963,9 +33502,15 @@ paths:
responses:
'200':
description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getSpaceResponseExample:
+ $ref: '#/components/examples/get_space_response'
summary: Get a space
tags:
- spaces
+ x-beta: true
put:
operationId: put-spaces-space-id
parameters:
@@ -34984,9 +33529,7 @@ paths:
schema:
example: 'true'
type: string
- - description: >-
- The space identifier. You are unable to change the ID with the
- update operation.
+ - description: The space identifier. You are unable to change the ID with the update operation.
in: path
name: id
required: true
@@ -35002,10 +33545,7 @@ paths:
_reserved:
type: boolean
color:
- description: >-
- The hexadecimal color code used in the space avatar. By
- default, the color is automatically generated from the space
- name.
+ description: The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
type: string
description:
description: A description for the space.
@@ -35017,26 +33557,13 @@ paths:
type: string
type: array
id:
- description: >-
- 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.
+ description: 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.
type: string
imageUrl:
- description: >-
- 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.
+ description: 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.
type: string
initials:
- description: >-
- One or two characters that are shown in the space avatar. By
- default, the initials are automatically generated from the
- space name.
+ description: One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.
maxLength: 2
type: string
name:
@@ -35046,12 +33573,16 @@ paths:
required:
- id
- name
+ examples:
+ updateSpaceRequest:
+ $ref: '#/components/examples/update_space_request'
responses:
'200':
description: Indicates a successful call.
summary: Update a space
tags:
- spaces
+ x-beta: true
/api/status:
get:
operationId: get-status
@@ -35083,11 +33614,8 @@ paths:
schema:
anyOf:
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_response'
- - $ref: >-
- #/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse
- description: >-
- Kibana's operational status. A minimal response is sent for
- unauthorized users.
+ - $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse'
+ description: Kibana's operational status. A minimal response is sent for unauthorized users.
description: Overall status is OK and Kibana should be functioning normally.
'503':
content:
@@ -35095,17 +33623,13 @@ paths:
schema:
anyOf:
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_response'
- - $ref: >-
- #/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse
- description: >-
- Kibana's operational status. A minimal response is sent for
- unauthorized users.
- description: >-
- Kibana or some of it's essential services are unavailable. Kibana
- may be degraded or unavailable.
+ - $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse'
+ description: Kibana's operational status. A minimal response is sent for unauthorized users.
+ description: Kibana or some of it's essential services are unavailable. Kibana may be degraded or unavailable.
summary: Get Kibana's current status
tags:
- system
+ x-beta: true
/api/timeline:
delete:
description: Delete one or more Timelines or Timeline templates.
@@ -35121,9 +33645,7 @@ paths:
type: string
type: array
searchIds:
- description: >-
- Saved search ids that should be deleted alongside the
- timelines
+ description: Saved search ids that should be deleted alongside the timelines
items:
type: string
type: array
@@ -35151,7 +33673,7 @@ paths:
summary: Delete Timelines or Timeline templates
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
get:
description: Get the details of an existing saved Timeline or Timeline template.
operationId: GetTimeline
@@ -35178,8 +33700,7 @@ paths:
type: object
properties:
getOneTimeline:
- $ref: >-
- #/components/schemas/Security_Timeline_API_TimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_TimelineResponse'
required:
- getOneTimeline
required:
@@ -35190,12 +33711,9 @@ paths:
summary: Get Timeline or Timeline template details
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
patch:
- description: >-
- Update an existing Timeline. You can update the title, description, date
- range, pinned events, pinned queries, and/or pinned saved queries of an
- existing Timeline.
+ description: Update an existing Timeline. You can update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing Timeline.
operationId: PatchTimeline
requestBody:
content:
@@ -35222,12 +33740,8 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
- description: >-
- Indicates that the draft Timeline was successfully created. In the
- event the user already has a draft Timeline, the existing draft
- Timeline is cleared and returned.
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
+ description: Indicates that the draft Timeline was successfully created. In the event the user already has a draft Timeline, the existing draft Timeline is cleared and returned.
'405':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -35238,13 +33752,11 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates that the user does not have the required access to create
- a draft Timeline.
+ description: Indicates that the user does not have the required access to create a draft Timeline.
summary: Update a Timeline
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
post:
description: Create a new Timeline or Timeline template.
operationId: CreateTimelines
@@ -35276,17 +33788,14 @@ paths:
type: string
required:
- timeline
- description: >-
- The required Timeline fields used to create a new Timeline, along with
- optional fields that will be created if not provided.
+ description: The required Timeline fields used to create a new Timeline, along with optional fields that will be created if not provided.
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
description: Indicates the Timeline was successfully created.
'405':
content:
@@ -35302,7 +33811,7 @@ paths:
summary: Create a Timeline or Timeline template
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/timeline/_copy:
get:
description: |
@@ -35327,19 +33836,15 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
description: Indicates that the timeline has been successfully copied.
summary: Copies timeline or timeline template
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/timeline/_draft:
get:
- description: >-
- Get the details of the draft Timeline or Timeline template for the
- current user. If the user doesn't have a draft Timeline, an empty
- Timeline is returned.
+ description: Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned.
operationId: GetDraftTimelines
parameters:
- in: query
@@ -35352,8 +33857,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
description: Indicates that the draft Timeline was successfully retrieved.
'403':
content:
@@ -35365,10 +33869,7 @@ paths:
type: string
status_code:
type: number
- description: >-
- If a draft Timeline was not found and we attempted to create one, it
- indicates that the user does not have the required permissions to
- create a draft Timeline.
+ description: If a draft Timeline was not found and we attempted to create one, it indicates that the user does not have the required permissions to create a draft Timeline.
'409':
content:
application:json; Elastic-Api-Version=2023-10-31:
@@ -35379,22 +33880,16 @@ paths:
type: string
status_code:
type: number
- description: >-
- This should never happen, but if a draft Timeline was not found and
- we attempted to create one, it indicates that there is already a
- draft Timeline with the given `timelineId`.
+ description: This should never happen, but if a draft Timeline was not found and we attempted to create one, it indicates that there is already a draft Timeline with the given `timelineId`.
summary: Get draft Timeline or Timeline template details
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
post:
- description: >
+ description: |
Create a clean draft Timeline or Timeline template for the current user.
-
> info
-
- > If the user already has a draft Timeline, the existing draft Timeline
- is cleared and returned.
+ > If the user already has a draft Timeline, the existing draft Timeline is cleared and returned.
operationId: CleanDraftTimelines
requestBody:
content:
@@ -35406,21 +33901,15 @@ paths:
$ref: '#/components/schemas/Security_Timeline_API_TimelineType'
required:
- timelineType
- description: >-
- The type of Timeline to create. Valid values are `default` and
- `template`.
+ description: The type of Timeline to create. Valid values are `default` and `template`.
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
- description: >-
- Indicates that the draft Timeline was successfully created. In the
- event the user already has a draft Timeline, the existing draft
- Timeline is cleared and returned.
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
+ description: Indicates that the draft Timeline was successfully created. In the event the user already has a draft Timeline, the existing draft Timeline is cleared and returned.
'403':
content:
application:json; Elastic-Api-Version=2023-10-31:
@@ -35431,9 +33920,7 @@ paths:
type: string
status_code:
type: number
- description: >-
- Indicates that the user does not have the required permissions to
- create a draft Timeline.
+ description: Indicates that the user does not have the required permissions to create a draft Timeline.
'409':
content:
application:json; Elastic-Api-Version=2023-10-31:
@@ -35444,13 +33931,11 @@ paths:
type: string
status_code:
type: number
- description: >-
- Indicates that there is already a draft Timeline with the given
- `timelineId`.
+ description: Indicates that there is already a draft Timeline with the given `timelineId`.
summary: Create a clean draft Timeline or Timeline template
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/timeline/_export:
post:
description: Export Timelines as an NDJSON file.
@@ -35497,7 +33982,7 @@ paths:
summary: Export Timelines
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/timeline/_favorite:
patch:
description: Favorite a Timeline or Timeline template for the current user.
@@ -35538,8 +34023,7 @@ paths:
type: object
properties:
persistFavorite:
- $ref: >-
- #/components/schemas/Security_Timeline_API_FavoriteTimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_FavoriteTimelineResponse'
required:
- persistFavorite
required:
@@ -35555,13 +34039,11 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates the user does not have the required permissions to persist
- the favorite status.
+ description: Indicates the user does not have the required permissions to persist the favorite status.
summary: Favorite a Timeline or Timeline template
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/timeline/_import:
post:
description: Import Timelines.
@@ -35587,8 +34069,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_ImportTimelineResult
+ $ref: '#/components/schemas/Security_Timeline_API_ImportTimelineResult'
description: Indicates the import of Timelines was successful.
'400':
content:
@@ -35602,9 +34083,7 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates the import of Timelines was unsuccessful because of an
- invalid file extension.
+ description: Indicates the import of Timelines was unsuccessful because of an invalid file extension.
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -35615,9 +34094,7 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates that we were unable to locate the saved object client
- necessary to handle the import.
+ description: Indicates that we were unable to locate the saved object client necessary to handle the import.
'409':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -35634,7 +34111,7 @@ paths:
summary: Import Timelines
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/timeline/_prepackaged:
post:
description: Install or update prepackaged Timelines.
@@ -35647,8 +34124,7 @@ paths:
properties:
prepackagedTimelines:
items:
- $ref: >-
- #/components/schemas/Security_Timeline_API_TimelineSavedToReturnObject
+ $ref: '#/components/schemas/Security_Timeline_API_TimelineSavedToReturnObject'
nullable: true
type: array
timelinesToInstall:
@@ -35672,8 +34148,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_ImportTimelineResult
+ $ref: '#/components/schemas/Security_Timeline_API_ImportTimelineResult'
description: Indicates the installation of prepackaged Timelines was successful.
'500':
content:
@@ -35685,13 +34160,11 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates the installation of prepackaged Timelines was
- unsuccessful.
+ description: Indicates the installation of prepackaged Timelines was unsuccessful.
summary: Install prepackaged Timelines
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/timeline/resolve:
get:
operationId: ResolveTimeline
@@ -35715,8 +34188,7 @@ paths:
- type: object
properties:
data:
- $ref: >-
- #/components/schemas/Security_Timeline_API_ResolvedTimeline
+ $ref: '#/components/schemas/Security_Timeline_API_ResolvedTimeline'
required:
- data
- additionalProperties: false
@@ -35729,15 +34201,13 @@ paths:
summary: Get an existing saved Timeline or Timeline template
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/api/timelines:
get:
description: Get a list of all saved Timelines or Timeline templates.
operationId: GetTimelines
parameters:
- - description: >-
- If true, only timelines that are marked as favorites by the user are
- returned.
+ - description: If true, only timelines that are marked as favorites by the user are returned.
in: query
name: only_user_favorite
schema:
@@ -35801,8 +34271,7 @@ paths:
type: number
timeline:
items:
- $ref: >-
- #/components/schemas/Security_Timeline_API_TimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_TimelineResponse'
type: array
totalCount:
type: number
@@ -35824,12 +34293,11 @@ paths:
summary: Get Timelines or Timeline templates
tags:
- Security Timeline API
- - access:securitySolution
+ x-beta: true
/s/{spaceId}/api/observability/slos:
get:
- description: >
- You must have the `read` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `read` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: findSlosOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -35877,9 +34345,7 @@ paths:
- asc
- desc
type: string
- - description: >-
- Hide stale SLOs from the list as defined by stale SLO threshold in
- SLO settings
+ - description: Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings
in: query
name: hideStale
schema:
@@ -35918,10 +34384,10 @@ paths:
summary: Get a paginated list of SLOs
tags:
- slo
+ x-beta: true
post:
- description: >
- You must have `all` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have `all` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: createSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -35968,12 +34434,11 @@ paths:
summary: Create an SLO
tags:
- slo
+ x-beta: true
/s/{spaceId}/api/observability/slos/_delete_instances:
post:
- description: >
- The deletion occurs for the specified list of `sloId` and `instanceId`.
- You must have `all` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ The deletion occurs for the specified list of `sloId` and `instanceId`. You must have `all` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: deleteSloInstancesOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -36010,11 +34475,11 @@ paths:
summary: Batch delete rollup and summary data
tags:
- slo
+ x-beta: true
/s/{spaceId}/api/observability/slos/{sloId}:
delete:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: deleteSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -36050,10 +34515,10 @@ paths:
summary: Delete an SLO
tags:
- slo
+ x-beta: true
get:
- description: >
- You must have the `read` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `read` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: getSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -36099,10 +34564,10 @@ paths:
summary: Get an SLO
tags:
- slo
+ x-beta: true
put:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: updateSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -36148,11 +34613,11 @@ paths:
summary: Update an SLO
tags:
- slo
+ x-beta: true
/s/{spaceId}/api/observability/slos/{sloId}/_reset:
post:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: resetSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -36192,11 +34657,11 @@ paths:
summary: Reset an SLO
tags:
- slo
+ x-beta: true
/s/{spaceId}/api/observability/slos/{sloId}/disable:
post:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: disableSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -36232,11 +34697,11 @@ paths:
summary: Disable an SLO
tags:
- slo
+ x-beta: true
/s/{spaceId}/api/observability/slos/{sloId}/enable:
post:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: enableSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -36272,6 +34737,7 @@ paths:
summary: Enable an SLO
tags:
- slo
+ x-beta: true
components:
examples:
Data_views_create_data_view_request:
@@ -36294,9 +34760,7 @@ components:
source: emit(doc["foo"].value)
type: long
Data_views_get_data_view_response:
- summary: >-
- The get data view API returns a JSON object that contains information
- about the data view.
+ summary: The get data view API returns a JSON object that contains information about the data view.
value:
data_view:
allowNoIndex: false
@@ -37247,10 +35711,7 @@ components:
value:
data_view_id: ff959d40-b880-11e8-a6d9-e546fe2bba5f
Data_views_get_runtime_field_response:
- summary: >-
- The get runtime field API returns a JSON object that contains
- information about the runtime field (`hour_of_day`) and the data view
- (`d3d7af60-4c81-11e8-b3d7-01146121b73d`).
+ summary: The get runtime field API returns a JSON object that contains information about the runtime field (`hour_of_day`) and the data view (`d3d7af60-4c81-11e8-b3d7-01146121b73d`).
value:
data_view:
allowNoIndex: false
@@ -37759,9 +36220,7 @@ components:
data_view_id: ff959d40-b880-11e8-a6d9-e546fe2bba5f
force: true
Data_views_swap_data_view_request:
- summary: >-
- Swap references from data view ID "abcd-efg" to "xyz-123" and remove the
- data view that is no longer referenced.
+ summary: Swap references from data view ID "abcd-efg" to "xyz-123" and remove the data view that is no longer referenced.
value:
delete: true
fromId: abcd-efg
@@ -37812,25 +36271,12 @@ components:
- id: de71f4f0-1902-11e9-919b-ffe5949a18d2
type: map
Serverless_saved_objects_export_objects_response:
- summary: >-
- The export objects API response contains a JSON record for each exported
- object.
+ summary: The export objects API response contains a JSON record for each exported object.
value:
attributes:
description: ''
- layerListJSON: >-
- [{"id":"0hmz5","alpha":1,"sourceDescriptor":{"type":"EMS_TMS","isAutoSelect":true,"lightModeDefault":"road_map_desaturated"},"visible":true,"style":{},"type":"EMS_VECTOR_TILE","minZoom":0,"maxZoom":24},{"id":"edh66","label":"Total
- Requests by
- Destination","minZoom":0,"maxZoom":24,"alpha":0.5,"sourceDescriptor":{"type":"EMS_FILE","id":"world_countries","tooltipProperties":["name","iso2"]},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"DYNAMIC","options":{"field":{"name":"__kbnjoin__count__673ff994-fc75-4c67-909b-69fcb0e1060e","origin":"join"},"color":"Greys","fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"lineColor":{"type":"STATIC","options":{"color":"#FFFFFF"}},"lineWidth":{"type":"STATIC","options":{"size":1}},"iconSize":{"type":"STATIC","options":{"size":10}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR","joins":[{"leftField":"iso2","right":{"type":"ES_TERM_SOURCE","id":"673ff994-fc75-4c67-909b-69fcb0e1060e","indexPatternTitle":"kibana_sample_data_logs","term":"geo.dest","indexPatternRefName":"layer_1_join_0_index_pattern","metrics":[{"type":"count","label":"web
- logs
- count"}],"applyGlobalQuery":true}}]},{"id":"gaxya","label":"Actual
- Requests","minZoom":9,"maxZoom":24,"alpha":1,"sourceDescriptor":{"id":"b7486535-171b-4d3b-bb2e-33c1a0a2854c","type":"ES_SEARCH","geoField":"geo.coordinates","limit":2048,"filterByMapBounds":true,"tooltipProperties":["clientip","timestamp","host","request","response","machine.os","agent","bytes"],"indexPatternRefName":"layer_2_source_index_pattern","applyGlobalQuery":true,"scalingType":"LIMIT"},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"STATIC","options":{"color":"#2200ff"}},"lineColor":{"type":"STATIC","options":{"color":"#FFFFFF"}},"lineWidth":{"type":"STATIC","options":{"size":2}},"iconSize":{"type":"DYNAMIC","options":{"field":{"name":"bytes","origin":"source"},"minSize":1,"maxSize":23,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR"},{"id":"tfi3f","label":"Total
- Requests and
- Bytes","minZoom":0,"maxZoom":9,"alpha":1,"sourceDescriptor":{"type":"ES_GEO_GRID","resolution":"COARSE","id":"8aaa65b5-a4e9-448b-9560-c98cb1c5ac5b","geoField":"geo.coordinates","requestType":"point","metrics":[{"type":"count","label":"web
- logs
- count"},{"type":"sum","field":"bytes"}],"indexPatternRefName":"layer_3_source_index_pattern","applyGlobalQuery":true},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"color":"Blues","fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"lineColor":{"type":"STATIC","options":{"color":"#cccccc"}},"lineWidth":{"type":"STATIC","options":{"size":1}},"iconSize":{"type":"DYNAMIC","options":{"field":{"name":"sum_of_bytes","origin":"source"},"minSize":7,"maxSize":25,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"labelText":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"labelSize":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"minSize":12,"maxSize":24,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR"}]
- mapStateJSON: >-
- {"zoom":3.64,"center":{"lon":-88.92107,"lat":42.16337},"timeFilters":{"from":"now-7d","to":"now"},"refreshConfig":{"isPaused":true,"interval":0},"query":{"language":"kuery","query":""},"settings":{"autoFitToDataBounds":false}}
+ layerListJSON: '[{"id":"0hmz5","alpha":1,"sourceDescriptor":{"type":"EMS_TMS","isAutoSelect":true,"lightModeDefault":"road_map_desaturated"},"visible":true,"style":{},"type":"EMS_VECTOR_TILE","minZoom":0,"maxZoom":24},{"id":"edh66","label":"Total Requests by Destination","minZoom":0,"maxZoom":24,"alpha":0.5,"sourceDescriptor":{"type":"EMS_FILE","id":"world_countries","tooltipProperties":["name","iso2"]},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"DYNAMIC","options":{"field":{"name":"__kbnjoin__count__673ff994-fc75-4c67-909b-69fcb0e1060e","origin":"join"},"color":"Greys","fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"lineColor":{"type":"STATIC","options":{"color":"#FFFFFF"}},"lineWidth":{"type":"STATIC","options":{"size":1}},"iconSize":{"type":"STATIC","options":{"size":10}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR","joins":[{"leftField":"iso2","right":{"type":"ES_TERM_SOURCE","id":"673ff994-fc75-4c67-909b-69fcb0e1060e","indexPatternTitle":"kibana_sample_data_logs","term":"geo.dest","indexPatternRefName":"layer_1_join_0_index_pattern","metrics":[{"type":"count","label":"web logs count"}],"applyGlobalQuery":true}}]},{"id":"gaxya","label":"Actual Requests","minZoom":9,"maxZoom":24,"alpha":1,"sourceDescriptor":{"id":"b7486535-171b-4d3b-bb2e-33c1a0a2854c","type":"ES_SEARCH","geoField":"geo.coordinates","limit":2048,"filterByMapBounds":true,"tooltipProperties":["clientip","timestamp","host","request","response","machine.os","agent","bytes"],"indexPatternRefName":"layer_2_source_index_pattern","applyGlobalQuery":true,"scalingType":"LIMIT"},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"STATIC","options":{"color":"#2200ff"}},"lineColor":{"type":"STATIC","options":{"color":"#FFFFFF"}},"lineWidth":{"type":"STATIC","options":{"size":2}},"iconSize":{"type":"DYNAMIC","options":{"field":{"name":"bytes","origin":"source"},"minSize":1,"maxSize":23,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR"},{"id":"tfi3f","label":"Total Requests and Bytes","minZoom":0,"maxZoom":9,"alpha":1,"sourceDescriptor":{"type":"ES_GEO_GRID","resolution":"COARSE","id":"8aaa65b5-a4e9-448b-9560-c98cb1c5ac5b","geoField":"geo.coordinates","requestType":"point","metrics":[{"type":"count","label":"web logs count"},{"type":"sum","field":"bytes"}],"indexPatternRefName":"layer_3_source_index_pattern","applyGlobalQuery":true},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"color":"Blues","fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"lineColor":{"type":"STATIC","options":{"color":"#cccccc"}},"lineWidth":{"type":"STATIC","options":{"size":1}},"iconSize":{"type":"DYNAMIC","options":{"field":{"name":"sum_of_bytes","origin":"source"},"minSize":7,"maxSize":25,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"labelText":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"labelSize":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"minSize":12,"maxSize":24,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR"}]'
+ mapStateJSON: '{"zoom":3.64,"center":{"lon":-88.92107,"lat":42.16337},"timeFilters":{"from":"now-7d","to":"now"},"refreshConfig":{"isPaused":true,"interval":0},"query":{"language":"kuery","query":""},"settings":{"autoFitToDataBounds":false}}'
title: '[Logs] Total Requests and Bytes'
uiStateJSON: '{"isDarkMode":false}'
coreMigrationVersion: 8.8.0
@@ -37855,10 +36301,7 @@ components:
value:
file: file.ndjson
Serverless_saved_objects_import_objects_response:
- summary: >-
- The import objects API response indicates a successful import and the
- objects are created. Since these objects are created as new copies, each
- entry in the successResults array includes a destinationId attribute.
+ summary: The import objects API response indicates a successful import and the objects are created. Since these objects are created as new copies, each entry in the successResults array includes a destinationId attribute.
value:
success: true
successCount: 1
@@ -37870,6 +36313,1191 @@ components:
icon: indexPatternApp
title: Kibana Sample Data Logs
type: index-pattern
+ get_connector_types_generativeai_response:
+ summary: A list of connector types for the `generativeAI` feature.
+ value:
+ - id: .gen-ai
+ name: OpenAI
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAIForSecurity
+ - generativeAIForObservability
+ - generativeAIForSearchPlayground
+ is_system_action_type: false
+ - id: .bedrock
+ name: AWS Bedrock
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAIForSecurity
+ - generativeAIForObservability
+ - generativeAIForSearchPlayground
+ is_system_action_type: false
+ - id: .gemini
+ name: Google Gemini
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAIForSecurity
+ is_system_action_type: false
+ get_connector_response:
+ summary: Get connector details.
+ value:
+ id: df770e30-8b8b-11ed-a780-3b746c987a81
+ name: my_server_log_connector
+ config: {}
+ connector_type_id: .server-log
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ update_index_connector_request:
+ summary: Update an index connector.
+ value:
+ name: updated-connector
+ config:
+ index: updated-index
+ create_email_connector_request:
+ summary: Create an email connector.
+ value:
+ name: email-connector-1
+ connector_type_id: .email
+ config:
+ from: tester@example.com
+ hasAuth: true
+ host: https://example.com
+ port: 1025
+ secure: false
+ service: other
+ secrets:
+ user: username
+ password: password
+ create_index_connector_request:
+ summary: Create an index connector.
+ value:
+ name: my-connector
+ connector_type_id: .index
+ config:
+ index: test-index
+ create_webhook_connector_request:
+ summary: Create a webhook connector with SSL authentication.
+ value:
+ name: my-webhook-connector
+ connector_type_id: .webhook
+ config:
+ method: post
+ url: https://example.com
+ authType: webhook-authentication-ssl
+ certType: ssl-crt-key
+ secrets:
+ crt: QmFnIEF0dH...
+ key: LS0tLS1CRUdJ...
+ password: my-passphrase
+ create_xmatters_connector_request:
+ summary: Create an xMatters connector with URL authentication.
+ value:
+ name: my-xmatters-connector
+ connector_type_id: .xmatters
+ config:
+ usesBasic: false
+ secrets:
+ secretsUrl: https://example.com?apiKey=xxxxx
+ create_email_connector_response:
+ summary: A new email connector.
+ value:
+ id: 90a82c60-478f-11ee-a343-f98a117c727f
+ connector_type_id: .email
+ name: email-connector-1
+ config:
+ from: tester@example.com
+ service: other
+ host: https://example.com
+ port: 1025
+ secure: false
+ hasAuth: true
+ tenantId: null
+ clientId: null
+ oauthTokenUrl: null
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ create_index_connector_response:
+ summary: A new index connector.
+ value:
+ id: c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
+ connector_type_id: .index
+ name: my-connector
+ config:
+ index: test-index
+ refresh: false
+ executionTimeField: null
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ create_webhook_connector_response:
+ summary: A new webhook connector.
+ value:
+ id: 900eb010-3b9d-11ee-a642-8ffbb94e38bd
+ name: my-webhook-connector
+ config:
+ method: post
+ url: https://example.com
+ authType: webhook-authentication-ssl
+ certType: ssl-crt-key
+ verificationMode: full
+ headers: null
+ hasAuth: true
+ connector_type_id: .webhook
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ run_index_connector_request:
+ summary: Run an index connector.
+ value:
+ params:
+ documents:
+ - id: my_doc_id
+ name: my_doc_name
+ message: hello, world
+ run_jira_connector_request:
+ summary: Run a Jira connector to retrieve the list of issue types.
+ value:
+ params:
+ subAction: issueTypes
+ run_servicenow_itom_connector_request:
+ summary: Run a ServiceNow ITOM connector to retrieve the list of choices.
+ value:
+ params:
+ subAction: getChoices
+ subActionParams:
+ fields:
+ - severity
+ - urgency
+ run_slack_api_connector_request:
+ summary: Run a Slack connector that uses the web API method to post a message on a channel.
+ value:
+ params:
+ subAction: postMessage
+ subActionParams:
+ channelIds:
+ - C123ABC456
+ text: A test message.
+ run_swimlane_connector_request:
+ summary: Run a Swimlane connector to create an incident.
+ value:
+ params:
+ subAction: pushToService
+ subActionParams:
+ comments:
+ - commentId: 1
+ comment: A comment about the incident.
+ incident:
+ caseId: '1000'
+ caseName: Case name
+ description: Description of the incident.
+ run_index_connector_response:
+ summary: Response from running an index connector.
+ value:
+ connector_id: fd38c600-96a5-11ed-bb79-353b74189cba
+ data:
+ errors: false
+ items:
+ - create:
+ _id: 4JtvwYUBrcyxt2NnfW3y
+ _index: my-index
+ _primary_term: 1
+ _seq_no: 0
+ _shards:
+ failed: 0
+ successful: 1
+ total: 2
+ _version: 1
+ result: created
+ status: 201
+ took: 135
+ status: ok
+ run_jira_connector_response:
+ summary: Response from retrieving the list of issue types for a Jira connector.
+ value:
+ connector_id: b3aad810-edbe-11ec-82d1-11348ecbf4a6
+ data:
+ - id: 10024
+ name: Improvement
+ - id: 10006
+ name: Task
+ - id: 10007
+ name: Sub-task
+ - id: 10025
+ name: New Feature
+ - id: 10023
+ name: Bug
+ - id: 10000
+ name: Epic
+ status: ok
+ run_server_log_connector_response:
+ summary: Response from running a server log connector.
+ value:
+ connector_id: 7fc7b9a0-ecc9-11ec-8736-e7d63118c907
+ status: ok
+ run_servicenow_itom_connector_response:
+ summary: Response from retrieving the list of choices for a ServiceNow ITOM connector.
+ value:
+ connector_id: 9d9be270-2fd2-11ed-b0e0-87533c532698
+ data:
+ - dependent_value: ''
+ element: severity
+ label: Critical
+ value: 1
+ - dependent_value: ''
+ element: severity
+ label: Major
+ value: 2
+ - dependent_value: ''
+ element: severity
+ label: Minor
+ value: 3
+ - dependent_value: ''
+ element: severity
+ label: Warning
+ value: 4
+ - dependent_value: ''
+ element: severity
+ label: OK
+ value: 5
+ - dependent_value: ''
+ element: severity
+ label: Clear
+ value: 0
+ - dependent_value: ''
+ element: urgency
+ label: 1 - High
+ value: 1
+ - dependent_value: ''
+ element: urgency
+ label: 2 - Medium
+ value: 2
+ - dependent_value: ''
+ element: urgency
+ label: 3 - Low
+ value: 3
+ status: ok
+ run_slack_api_connector_response:
+ summary: Response from posting a message with a Slack connector.
+ value:
+ status: ok
+ data:
+ ok: true
+ channel: C123ABC456
+ ts: '1234567890.123456'
+ message:
+ bot_id: B12BCDEFGHI
+ type: message
+ text: A test message
+ user: U12A345BC6D
+ ts: '1234567890.123456'
+ app_id: A01BC2D34EF
+ blocks:
+ - type: rich_text
+ block_id: /NXe
+ elements:
+ - type: rich_text_section
+ elements:
+ - type: text
+ text: A test message.
+ team: T01ABCDE2F
+ bot_profile:
+ id: B12BCDEFGHI
+ app_id: A01BC2D34EF
+ name: test
+ icons:
+ image_36: https://a.slack-edge.com/80588/img/plugins/app/bot_36.png
+ deleted: false
+ updated: 1672169705
+ team_id: T01ABCDE2F
+ connector_id: .slack_api
+ run_swimlane_connector_response:
+ summary: Response from creating a Swimlane incident.
+ value:
+ connector_id: a4746470-2f94-11ed-b0e0-87533c532698
+ data:
+ id: aKPmBHWzmdRQtx6Mx
+ title: TEST-457
+ url: https://elastic.swimlane.url.us/record/aNcL2xniGHGpa2AHb/aKPmBHWzmdRQtx6Mx
+ pushedDate: '2022-09-08T16:52:27.866Z'
+ comments:
+ - commentId: 1
+ pushedDate: '2022-09-08T16:52:27.865Z'
+ status: ok
+ get_connectors_response:
+ summary: A list of connectors
+ value:
+ - id: preconfigured-email-connector
+ name: my-preconfigured-email-notification
+ connector_type_id: .email
+ is_preconfigured: true
+ is_deprecated: false
+ referenced_by_count: 0
+ is_system_action: false
+ - id: e07d0c80-8b8b-11ed-a780-3b746c987a81
+ name: my-index-connector
+ config:
+ index: test-index
+ refresh: false
+ executionTimeField: null
+ connector_type_id: .index
+ is_preconfigured: false
+ is_deprecated: false
+ referenced_by_count: 2
+ is_missing_secrets: false
+ is_system_action: false
+ update_rule_request:
+ summary: Index threshold rule
+ description: Update an index threshold rule that uses a server log connector to send notifications when the threshold is met.
+ value:
+ actions:
+ - frequency:
+ summary: false
+ notify_when: onActionGroupChange
+ group: threshold met
+ id: 96b668d0-a1b6-11ed-afdf-d39a49596974
+ params:
+ level: info
+ message: |-
+ Rule {{rule.name}} is active for group {{context.group}}:
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}}
+ params:
+ aggField: sheet.version
+ aggType: avg
+ index:
+ - .updated-index
+ groupBy: top
+ termField: name.keyword
+ termSize: 6
+ threshold:
+ - 1000
+ thresholdComparator: '>'
+ timeField: '@timestamp'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ name: new name
+ schedule:
+ interval: 1m
+ tags: []
+ update_rule_response:
+ summary: Index threshold rule
+ description: The response for successfully updating an index threshold rule.
+ value:
+ id: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
+ consumer: alerts
+ tags: []
+ name: new name
+ enabled: true
+ throttle: null
+ revision: 1
+ running: false
+ schedule:
+ interval: 1m
+ params:
+ index:
+ - .updated-index
+ timeField: '@timestamp'
+ groupBy: top
+ aggType: avg
+ timeWindowSize: 5
+ timeWindowUnit: m
+ thresholdComparator: '>'
+ threshold:
+ - 1000
+ aggField: sheet.version
+ termField: name.keyword
+ termSize: 6
+ api_key_owner: elastic
+ created_by: elastic
+ updated_by: elastic
+ rule_type_id: .index-threshold
+ scheduled_task_id: 4c5eda00-e74f-11ec-b72f-5b18752ff9ea
+ created_at: '2024-03-26T23:13:20.985Z'
+ updated_at: '2024-03-26T23:22:59.949Z'
+ mute_all: false
+ muted_alert_ids: []
+ execution_status:
+ status: ok
+ last_execution_date: '2024-03-26T23:22:51.390Z'
+ last_duration: 52
+ actions:
+ - group: threshold met
+ params:
+ level: info
+ message: |-
+ Rule {{rule.name}} is active for group {{context.group}}:
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}
+ id: 96b668d0-a1b6-11ed-afdf-d39a49596974
+ uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
+ connector_type_id: .server-log
+ frequency:
+ summary: false
+ throttle: null
+ notify_when: onActionGroupChange
+ last_run:
+ alerts_count:
+ new: 0
+ ignored: 0
+ recovered: 0
+ active: 0
+ outcome_msg: null
+ warning: null
+ outcome: succeeded
+ next_run: '2024-03-26T23:23:51.316Z'
+ api_key_created_by_user: false
+ create_es_query_esql_rule_request:
+ summary: Elasticsearch query rule (ES|QL)
+ description: |
+ Create an Elasticsearch query rule that uses Elasticsearch Query Language (ES|QL) to define its query and a server log connector to send notifications.
+ value:
+ name: my Elasticsearch query ESQL rule
+ params:
+ searchType: esqlQuery
+ esqlQuery:
+ esql: FROM kibana_sample_data_logs | KEEP bytes, clientip, host, geo.dest | where geo.dest != "GB" | STATS sumbytes = sum(bytes) by clientip, host | WHERE sumbytes > 5000 | SORT sumbytes desc | LIMIT 10
+ timeField: '@timestamp'
+ timeWindowSize: 1
+ timeWindowUnit: d
+ size: 0
+ thresholdComparator: '>'
+ threshold:
+ - 0
+ consumer: stackAlerts
+ rule_type_id: .es-query
+ schedule:
+ interval: 1d
+ actions:
+ - group: query matched
+ id: d0db1fe0-78d6-11ee-9177-f7d404c8c945
+ params:
+ level: info
+ message: |-
+ Elasticsearch query rule '{{rule.name}}' is active:
+ - Value: {{context.value}} - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}} - Timestamp: {{context.date}} - Link: {{context.link}}
+ frequency:
+ summary: false
+ notify_when: onActiveAlert
+ create_es_query_rule_request:
+ summary: Elasticsearch query rule (DSL)
+ description: |
+ Create an Elasticsearch query rule that uses Elasticsearch query domain specific language (DSL) to define its query and a server log connector to send notifications.
+ value:
+ actions:
+ - group: query matched
+ params:
+ level: info
+ message: The system has detected {{alerts.new.count}} new, {{alerts.ongoing.count}} ongoing, and {{alerts.recovered.count}} recovered alerts.
+ id: fdbece50-406c-11ee-850e-c71febc4ca7f
+ frequency:
+ throttle: 1d
+ summary: true
+ notify_when: onThrottleInterval
+ - group: recovered
+ params:
+ level: info
+ message: Recovered
+ id: fdbece50-406c-11ee-850e-c71febc4ca7f
+ frequency:
+ summary: false
+ notify_when: onActionGroupChange
+ consumer: alerts
+ name: my Elasticsearch query rule
+ params:
+ esQuery: '"""{"query":{"match_all" : {}}}"""'
+ index:
+ - kibana_sample_data_logs
+ size: 100
+ threshold:
+ - 100
+ thresholdComparator: '>'
+ timeField: '@timestamp'
+ timeWindowSize: 1
+ timeWindowUnit: d
+ rule_type_id: .es-query
+ schedule:
+ interval: 1d
+ create_es_query_kql_rule_request:
+ summary: Elasticsearch query rule (KQL)
+ description: Create an Elasticsearch query rule that uses Kibana query language (KQL).
+ value:
+ consumer: alerts
+ name: my Elasticsearch query KQL rule
+ params:
+ aggType: count
+ excludeHitsFromPreviousRun: true
+ groupBy: all
+ searchConfiguration:
+ query:
+ query: '""geo.src : "US" ""'
+ language: kuery
+ index: 90943e30-9a47-11e8-b64d-95841ca0b247
+ searchType: searchSource
+ size: 100
+ threshold:
+ - 1000
+ thresholdComparator: '>'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ rule_type_id: .es-query
+ schedule:
+ interval: 1m
+ create_index_threshold_rule_request:
+ summary: Index threshold rule
+ description: |
+ Create an index threshold rule that uses a server log connector to send notifications when the threshold is met.
+ value:
+ actions:
+ - id: 48de3460-f401-11ed-9f8e-399c75a2deeb
+ frequency:
+ notify_when: onActionGroupChange
+ summary: false
+ group: threshold met
+ params:
+ level: info
+ message: |-
+ Rule '{{rule.name}}' is active for group '{{context.group}}':
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}}
+ alert_delay:
+ active: 3
+ consumer: alerts
+ name: my rule
+ params:
+ aggType: avg
+ termSize: 6
+ thresholdComparator: '>'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ groupBy: top
+ threshold:
+ - 1000
+ index:
+ - .test-index
+ timeField: '@timestamp'
+ aggField: sheet.version
+ termField: name.keyword
+ rule_type_id: .index-threshold
+ schedule:
+ interval: 1m
+ tags:
+ - cpu
+ create_tracking_containment_rule_request:
+ summary: Tracking containment rule
+ description: |
+ Create a tracking containment rule that checks when an entity is contained or no longer contained within a boundary.
+ value:
+ consumer: alerts
+ name: my tracking rule
+ params:
+ index: kibana_sample_data_logs
+ dateField": '@timestamp'
+ geoField: geo.coordinates
+ entity: agent.keyword
+ boundaryType: entireIndex
+ boundaryIndexTitle: boundary*
+ boundaryGeoField: location
+ boundaryNameField: name
+ indexId: 90943e30-9a47-11e8-b64d-95841ca0b247
+ boundaryIndexId: 0cd90abf-abe7-44c7-909a-f621bbbcfefc
+ rule_type_id: .geo-containment
+ schedule:
+ interval: 1h
+ create_es_query_esql_rule_response:
+ summary: Elasticsearch query rule (ES|QL)
+ description: The response for successfully creating an Elasticsearch query rule that uses Elasticsearch Query Language (ES|QL).
+ value:
+ id: e0d62360-78e8-11ee-9177-f7d404c8c945
+ enabled: true
+ name: my Elasticsearch query ESQL rule
+ tags: []
+ rule_type_id: .es-query
+ consumer: stackAlerts
+ schedule:
+ interval: 1d
+ actions:
+ - group: query matched
+ id: d0db1fe0-78d6-11ee-9177-f7d404c8c945
+ params:
+ level: info
+ message: |-
+ Elasticsearch query rule '{{rule.name}}' is active:
+ - Value: {{context.value}} - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}} - Timestamp: {{context.date}} - Link: {{context.link}}
+ connector_type_id: .server-log
+ frequency:
+ summary: false
+ notify_when: onActiveAlert
+ throttle: null
+ uuid: bfe370a3-531b-4855-bbe6-ad739f578844
+ params:
+ searchType: esqlQuery
+ esqlQuery:
+ esql: FROM kibana_sample_data_logs | keep bytes, clientip, host, geo.dest | WHERE geo.dest != "GB" | stats sumbytes = sum(bytes) by clientip, host | WHERE sumbytes > 5000 | sort sumbytes desc | limit 10
+ timeField: '@timestamp'
+ timeWindowSize: 1
+ timeWindowUnit: d
+ size: 0
+ thresholdComparator: '>'
+ threshold:
+ - 0
+ excludeHitsFromPreviousRun": true,
+ aggType: count
+ groupBy: all
+ scheduled_task_id: e0d62360-78e8-11ee-9177-f7d404c8c945
+ created_by: elastic
+ updated_by: elastic",
+ created_at: '2023-11-01T19:00:10.453Z'
+ updated_at: '2023-11-01T19:00:10.453Z'
+ api_key_owner: elastic
+ api_key_created_by_user: false
+ throttle: null
+ mute_all: false
+ notify_when: null
+ muted_alert_ids: []
+ execution_status:
+ status: pending
+ last_execution_date: '2023-11-01T19:00:10.453Z'
+ revision: 0
+ running: false
+ create_es_query_rule_response:
+ summary: Elasticsearch query rule (DSL)
+ description: The response for successfully creating an Elasticsearch query rule that uses Elasticsearch query domain specific language (DSL).
+ value:
+ id: 58148c70-407f-11ee-850e-c71febc4ca7f
+ enabled: true
+ name: my Elasticsearch query rule
+ tags: []
+ rule_type_id: .es-query
+ consumer: alerts
+ schedule:
+ interval: 1d
+ actions:
+ - group: query matched
+ id: fdbece50-406c-11ee-850e-c71febc4ca7f
+ params:
+ level: info
+ message: The system has detected {{alerts.new.count}} new, {{alerts.ongoing.count}} ongoing, and {{alerts.recovered.count}} recovered alerts.
+ connector_type_id: .server-log
+ frequency:
+ summary: true
+ notify_when: onThrottleInterval
+ throttle: 1d
+ uuid: 53f3c2a3-e5d0-4cfa-af3b-6f0881385e78
+ - group: recovered
+ id: fdbece50-406c-11ee-850e-c71febc4ca7f
+ params:
+ level: info
+ message: Recovered
+ connector_type_id: .server-log
+ frequency:
+ summary: false
+ notify_when: onActionGroupChange
+ throttle: null
+ uuid: 2324e45b-c0df-45c7-9d70-4993e30be758
+ params:
+ thresholdComparator: '>'
+ timeWindowSize: 1
+ timeWindowUnit: d
+ threshold:
+ - 100
+ size: 100
+ timeField: '@timestamp'
+ index:
+ - kibana_sample_data_logs
+ esQuery: '"""{"query":{"match_all" : {}}}"""'
+ excludeHitsFromPreviousRun: true
+ aggType: count
+ groupBy: all
+ searchType: esQuery
+ scheduled_task_id: 58148c70-407f-11ee-850e-c71febc4ca7f
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2023-08-22T00:03:38.263Z'
+ updated_at: '2023-08-22T00:03:38.263Z'
+ api_key_owner: elastic
+ api_key_created_by_user: false
+ throttle: null
+ mute_all: false
+ notify_when: null
+ muted_alert_ids: []
+ execution_status:
+ status: pending
+ last_execution_date: '2023-08-22T00:03:38.263Z'
+ revision: 0
+ running: false
+ create_es_query_kql_rule_response:
+ summary: Elasticsearch query rule (KQL)
+ description: The response for successfully creating an Elasticsearch query rule that uses Kibana query language (KQL).
+ value:
+ id: 7bd506d0-2284-11ee-8fad-6101956ced88
+ enabled: true
+ name: my Elasticsearch query KQL rule"
+ tags: []
+ rule_type_id: .es-query
+ consumer: alerts
+ schedule:
+ interval: 1m
+ actions: []
+ params:
+ searchConfiguration:
+ query:
+ query: '""geo.src : "US" ""'
+ language: kuery
+ index: 90943e30-9a47-11e8-b64d-95841ca0b247
+ searchType: searchSource
+ timeWindowSize: 5
+ timeWindowUnit: m
+ threshold:
+ - 1000
+ thresholdComparator: '>'
+ size: 100
+ aggType: count
+ groupBy: all
+ excludeHitsFromPreviousRun: true
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2023-07-14T20:24:50.729Z'
+ updated_at: '2023-07-14T20:24:50.729Z'
+ api_key_owner: elastic
+ api_key_created_by_user: false
+ throttle: null
+ notify_when: null
+ mute_all: false
+ muted_alert_ids: []
+ scheduled_task_id: 7bd506d0-2284-11ee-8fad-6101956ced88
+ execution_status:
+ status: pending
+ last_execution_date: '2023-07-14T20:24:50.729Z'
+ revision: 0
+ running: false
+ create_index_threshold_rule_response:
+ summary: Index threshold rule
+ description: The response for successfully creating an index threshold rule.
+ value:
+ actions:
+ - group: threshold met
+ id: dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2
+ uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
+ connector_type_id: .server-log
+ frequency:
+ notify_when: onActionGroupChange
+ summary: false
+ throttle: null
+ params:
+ level: info
+ message: |-
+ Rule {{rule.name}} is active for group {{context.group} :
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}}
+ alert_delay:
+ active: 3
+ api_key_created_by_user: false
+ api_key_owner: elastic
+ consumer: alerts
+ created_at: '2022-06-08T17:20:31.632Z'
+ created_by: elastic
+ enabled: true
+ execution_status:
+ last_execution_date: '2022-06-08T17:20:31.632Z'
+ status: pending
+ id: 41893910-6bca-11eb-9e0d-85d233e3ee35
+ muted_alert_ids: []
+ mute_all: false
+ name: my rule
+ notify_when: null
+ params:
+ aggType: avg
+ termSize: 6
+ thresholdComparator: '>'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ groupBy: top
+ threshold:
+ - 1000
+ index:
+ - .test-index
+ timeField: '@timestamp'
+ aggField: sheet.version
+ termField: name.keyword
+ revision: 0
+ rule_type_id: .index-threshold
+ running: false
+ schedule:
+ interval: 1m
+ scheduled_task_id: 425b0800-6bca-11eb-9e0d-85d233e3ee35
+ tags:
+ - cpu
+ throttle: null
+ updated_at: '2022-06-08T17:20:31.632Z'
+ updated_by: elastic
+ create_tracking_containment_rule_response:
+ summary: Tracking containment rule
+ description: The response for successfully creating a tracking containment rule.
+ value:
+ id: b6883f9d-5f70-4758-a66e-369d7c26012f
+ name: my tracking rule
+ tags: []
+ enabled: true
+ consumer: alerts
+ throttle: null
+ revision: 1
+ running: false
+ schedule:
+ interval: 1h
+ params:
+ index: kibana_sample_data_logs
+ dateField: '@timestamp'
+ geoField: geo.coordinates
+ entity: agent.keyword
+ boundaryType: entireIndex
+ boundaryIndexTitle: boundary*
+ boundaryGeoField: location
+ boundaryNameField: name
+ indexId: 90943e30-9a47-11e8-b64d-95841ca0b247
+ boundaryIndexId: 0cd90abf-abe7-44c7-909a-f621bbbcfefc
+ rule_type_id: .geo-containment
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2024-02-14T19:52:55.920Z'
+ updated_at: '2024-02-15T03:24:32.574Z'
+ api_key_owner: elastic
+ notify_when: null
+ mute_all: false
+ muted_alert_ids: []
+ scheduled_task_id: b6883f9d-5f70-4758-a66e-369d7c26012f
+ execution_status:
+ status: ok
+ last_execution_date: '2024-02-15T03:25:38.125Z'
+ last_duration: 74
+ actions: []
+ last_run:
+ alerts_count:
+ active: 0
+ new: 0
+ recovered: 0
+ ignored: 0
+ outcome_msg: null
+ outcome_order: 0
+ outcome: succeeded
+ warning: null
+ next_run: '2024-02-15T03:26:38.033Z'
+ api_key_created_by_user: false
+ find_rules_response:
+ summary: Index threshold rule
+ description: A response that contains information about an index threshold rule.
+ value:
+ page: 1
+ total: 1
+ per_page: 10
+ data:
+ - id: 3583a470-74f6-11ed-9801-35303b735aef
+ consumer: alerts
+ tags:
+ - cpu
+ name: my alert
+ enabled: true
+ throttle: null
+ schedule:
+ interval: 1m
+ params:
+ aggType: avg
+ termSize: 6
+ thresholdComparator: '>'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ groupBy: top
+ threshold:
+ - 1000
+ index:
+ - test-index
+ timeField: '@timestamp'
+ aggField: sheet.version
+ termField: name.keyword
+ revision: 1
+ rule_type_id: .index-threshold
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2022-12-05T23:40:33.132Z'
+ updated_at: '2022-12-05T23:40:33.132Z'
+ api_key_owner: elastic
+ mute_all: false
+ muted_alert_ids: []
+ scheduled_task_id: 3583a470-74f6-11ed-9801-35303b735aef
+ execution_status:
+ status: ok
+ last_execution_date: '2022-12-06T01:44:23.983Z'
+ last_duration: 48
+ actions:
+ - id: 9dca3e00-74f5-11ed-9801-35303b735aef
+ group: threshold met
+ uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
+ params:
+ level: info
+ message: |-
+ Rule {{rule.name}} is active for group {{context.group}}:
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}}
+ connector_type_id: .server-log
+ frequency:
+ summary: false
+ notify_when: onActionGroupChange
+ throttle: null
+ last_run:
+ alerts_count:
+ new: 0
+ ignored: 0
+ recovered: 0
+ active: 0
+ outcome_msg: null
+ warning: null
+ outcome: succeeded
+ next_run: '2022-12-06T01:45:23.912Z'
+ api_key_created_by_user: false
+ find_rules_response_conditional_action:
+ summary: Security rule
+ description: A response that contains information about a security rule that has conditional actions.
+ value:
+ page: 1
+ total: 1
+ per_page: 10
+ data:
+ - id: 6107a8f0-f401-11ed-9f8e-399c75a2deeb
+ name: security_rule
+ consumer: siem
+ enabled: true
+ tags: []
+ throttle: null
+ revision: 1
+ running: false
+ schedule:
+ interval: 1m
+ params:
+ author: []
+ description: A security threshold rule.
+ ruleId: an_internal_rule_id
+ falsePositives: []
+ from: now-3660s
+ immutable: false
+ license: ''
+ outputIndex: ''
+ meta:
+ from: 1h
+ kibana_siem_app_url: https://localhost:5601/app/security
+ maxSignals: 100
+ riskScore: 21
+ riskScoreMapping: []
+ severity: low
+ severityMapping: []
+ threat: []
+ to: now
+ references: []
+ version: 1
+ exceptionsList: []
+ type: threshold
+ language: kuery
+ index:
+ - kibana_sample_data_logs
+ query: '*'
+ filters: []
+ threshold:
+ field:
+ - bytes
+ value: 1
+ cardinality: []
+ rule_type_id: siem.thresholdRule
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2023-05-16T15:50:28.358Z'
+ updated_at: '2023-05-16T20:25:42.559Z'
+ api_key_owner: elastic
+ notify_when: null
+ mute_all: false
+ muted_alert_ids: []
+ scheduled_task_id: 6107a8f0-f401-11ed-9f8e-399c75a2deeb
+ execution_status:
+ status: ok
+ last_execution_date: '2023-05-16T20:26:49.590Z'
+ last_duration: 166
+ actions:
+ - group: default
+ id: 49eae970-f401-11ed-9f8e-399c75a2deeb
+ params:
+ documents:
+ - rule_id:
+ '[object Object]': null
+ rule_name:
+ '[object Object]': null
+ alert_id:
+ '[object Object]': null
+ context_message:
+ '[object Object]': null
+ connector_type_id: .index
+ frequency:
+ summary: true
+ notify_when: onActiveAlert
+ throttle: null
+ uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
+ alerts_filter:
+ timeframe:
+ days:
+ - 7
+ timezone: UTC
+ hours:
+ start: '08:00'
+ end: '17:00'
+ query:
+ kql: ''
+ filters:
+ - meta:
+ disabled: false
+ negate: false
+ alias: null
+ index: c4bdca79-e69e-4d80-82a1-e5192c621bea
+ key: client.geo.region_iso_code
+ field: client.geo.region_iso_code
+ params:
+ query: CA-QC
+ type: phrase
+ $state:
+ store: appState
+ query:
+ match_phrase:
+ client.geo.region_iso_code: CA-QC
+ last_run:
+ alerts_count:
+ new: 0
+ ignored: 0
+ recovered: 0
+ active: 0
+ outcome_msg:
+ - Rule execution completed successfully
+ outcome_order: 0
+ warning: null
+ outcome: succeeded
+ next_run: '2023-05-16T20:27:49.507Z'
+ api_key_created_by_user: false
+ get_spaces_response1:
+ summary: Get all spaces
+ description: Get all spaces without specifying any options.
+ value:
+ - id: default
+ name: Default
+ description: This is the Default Space
+ disabledFeatures: []
+ imageUrl: ''
+ _reserved: true
+ - id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ disabledFeatures:
+ - apm
+ initials: MK
+ imageUrl: data:image/png;base64,iVBORw0KGgoAAAANSU
+ - id: sales
+ name: Sales
+ initials: MK
+ disabledFeatures:
+ - discover
+ imageUr": ''
+ solution: oblt
+ get_spaces_response2:
+ summary: Get all spaces with custom options
+ description: |
+ The user has read-only access to the Sales space. Get all spaces with the following query parameters: "purpose=shareSavedObjectsIntoSpace&include_authorized_purposes=true"
+ value:
+ - id: default
+ name: Default
+ description: This is the Default Space
+ disabledFeatures: []
+ imageUrl: ''
+ _reserved: true
+ authorizedPurposes:
+ any: true
+ copySavedObjectsIntoSpace: true
+ findSavedObjects: true
+ shareSavedObjectsIntoSpace: true
+ - id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ disabledFeatures:
+ - apm
+ initials: MK
+ imageUrl: data:image/png;base64,iVBORw0KGgoAAAANSU
+ authorizedPurposes:
+ any: true
+ copySavedObjectsIntoSpace: true
+ findSavedObjects: true
+ shareSavedObjectsIntoSpace: true
+ - id: sales
+ name: Sales
+ initials: MK
+ disabledFeatures:
+ - discover
+ imageUrl: ''
+ authorizedPurposes:
+ any: true
+ copySavedObjectsIntoSpace: false
+ findSavedObjects: true
+ shareSavedObjectsIntoSpace: false
+ create_space_request:
+ summary: Create a marketing space
+ value:
+ id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ initials: MK
+ disabledFeatures: []
+ imageUrl: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAD4AAABACAYAAABC6cT1AAAGf0lEQVRoQ+3abYydRRUH8N882xYo0IqagEVjokQJKAiKBjXExC9G/aCkGowCIghCkRcrVSSKIu/FEiqgGL6gBIlAYrAqUTH6hZgQFVEMKlQFfItWoQWhZe8z5uzMLdvbfbkLxb13d+fbvfe588x/zpn/+Z9zJpmnI81T3BaAzzfLL1h8weLzZAcWXH2eGHo7zAWLL1h8nuzAjFw9G1N6Kzq8HnuM36MR8iibF3Fv4q+7cv8yDV6K13bYq2furSP8Ag8ncr/vnSnwRViJT2GfCV7yL1yHGxLb+l3EdM9lluNEnIC9xz+f2ZL4Er6Z2DrdXN3fZwp8CU7OfDHxggle8lTLbQ1nJ/7Z7yKmey5zYGZt4h2IzR8/trRc2PDlxJPTzfVcgJ+CC0wMPOa9F6cm7up3EVM9V9386MxliVdM8GwAv6hh/awCz/w7lY25OtF5ruBz4ZLP42NYNrDAFbC3YPWuILnMAfgq3oaRQQYea/stViV+sgssvjKzLvGySeaaNVfP4d7Btokgvxj/bblgpueuF1hmWcyTCmfE3J3M1lTcv0vMswM88zR+jpw4osu6me8kzkpsfLZWzxyRuabO22buxxOJ12FxnXfWgEe83pB5sOE47BsLymzscOoi7nw2JJfZreUjiUsTyzKPZm5NvBDvSuw268AzNzV8H5/Am+qCnsAXgpgSW2Zq9cyKlksbPlTd+te4quWNieMHBfiNDdciYnwsdI/MaOaWhnMTf54J8CqNj8x8JXFIZltYu+HqlmNT8YSBsHgAPw/vxvlVV4du/s0oaxbxg0TbL/jMni0nNcVjQq7+HZfgtpbzBg342TgQ63AkmsymxBW4IjE6A+D7Vzd/fyWxIM/VuCe+HzTgZ2Jpy/kNJ2FJLmLm24mPJ/42A+Bvrxt4SISwlhsaPodH26LZB8rVA3inwwebsrixJCZzX+KMxI/7AV61eVh3DV6Mx3EOvh4kN6jAg8nfUCXm4d1wE66OyxNPTQc+s3/o/MoXizL3JE5O3F3P/uBZPPF4Zr+Wi5uSO48ZPRdyCwn7YB/A35m5KhWNHox4fcNnIs0ddOCRSBxf8+cQG+Huf0l8NJVYP+nI7NXy2ar4QqIGm69JfKPOE2w/mBavCzwM11R2D+ChsUO7hyUfmwx55qDM1xJvqZ7y08TpifuGBfjeURVJnNIVGpkNiXNS0ds7jcySDitDCCWW56LJ10fRo8sNA+3qXUSZD2CtQlZh9T+1rB7h9oliembflnMbzqgSNZKbKGHdPm7OwXb1CvQ1metSETMpszmzvikCJNh/h5E5PHNl4qga/+/cxqrdeWDYgIe7X5L4cGJPJX2940lOX8pD41FnFnc4riluvQKbK0dcHJFi2IBHNTQSlguru4d2/wPOTNzRA3x5y+U1E1uqWDkETOT026XuUJzx6u7ReLhSYenQ7uHua0fKZmwfmcPqsQjxE5WVONcRxn7X89zgn/EKPMRMxOVQXmP18Mx3q3b/Y/0cQE/IhFtHESMsHFlZ1Ml3CH3DZPHImY+pxcKumNmYirtvqMBfhMuU6s3iqOQkTsMPe1tCQwO8Ajs0lxr7W+vnp1MJc9EgCNd/cy6x+9D4veXmprj5wxMw/3C4egW6zzgZOlYZzfwo3F2J7ael0pJamvlPKgWNKFft1AAcKotXoFEbD7kaoSoQPVKB35+5KHF0lai/rJo+up87jWEE/qqqwY+qrL21LWLm95lPJ16ppKw31XC3PXYPJauPEx7B6BHCgrSizRs18qiaRp8tlN3ueCTYPHH9RNaunjI8Z7wLYpT3jZSCYXQ8e9vTsRE/q+no3XMKeObgGtaintbb/AvXj4JDkNw/5hrwYPfIvlZFUbLn7G5q+eQIN09Vnho6cqvnM/Lt99RixH49wO8K0ZL41WTWHoQzvsNVkOheZqKhEGpsp3SzB+BBtZAYve7uOR9tuTaaB6l0XScdYfEQPpkTUyHEGP+XqyDBzu+NBCITUjNWHynkrbWKOuWFn1xKzqsyx0bdvS78odp0+N503Zao0uCsWuSIDku8/7EO60b41vN5+Ses9BKlTdvd8bhp9EBvJjWJAIn/vxwHe6b3tSk6JFPV4nq85oAOrx555v/x/rh3E6Lo+bnuNS4uB4Cuq0ZfvO8X1rM6q/+vnjLVqZq7v83onttc2oYF4HPJmv1gWbB4P7s0l55ZsPhcsmY/WBYs3s8uzaVn5q3F/wf70mRuBCtbjQAAAABJRU5ErkJggg==
+ get_space_response:
+ summary: Get details about a marketing space
+ value:
+ id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ initials: MK
+ disabledFeatures: []
+ imageUrl: ''
+ solution: es
+ update_space_request:
+ summary: Update a marketing space
+ description: Update the marketing space to remove the imageUrl.
+ value:
+ id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ initials: MK
+ disabledFeatures: []
+ imageUrl: ''
parameters:
APM_UI_elastic_api_version:
description: The version of the API to use
@@ -37913,9 +37541,7 @@ components:
example: ff959d40-b880-11e8-a6d9-e546fe2bba5f
type: string
Machine_learning_APIs_simulateParam:
- description: >-
- When true, simulates the synchronization by returning only the list of
- actions that would be performed.
+ description: When true, simulates the synchronization by returning only the list of actions that would be performed.
example: 'true'
in: query
name: simulate
@@ -37945,9 +37571,7 @@ components:
example: 9c235211-6834-11ea-a78c-6feb38a34414
type: string
SLOs_space_id:
- description: >-
- An identifier for the space. If `/s/` and the identifier are omitted
- from the path, the default space is used.
+ description: An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used.
in: path
name: spaceId
required: true
@@ -38272,10 +37896,8 @@ components:
example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85
type: string
mark_as_applied_by_agent:
- description: >
- `markAsAppliedByAgent=true` means "force setting it to true
- regardless of etag".
-
+ description: |
+ `markAsAppliedByAgent=true` means "force setting it to true regardless of etag".
This is needed for Jaeger agent that doesn't have etags
type: boolean
service:
@@ -38390,9 +38012,7 @@ components:
type: object
properties:
bundle_filepath:
- description: >-
- The absolute path of the final bundle as used in the web
- application.
+ description: The absolute path of the final bundle as used in the web application.
type: string
service_name:
description: The name of the service that the service map should apply to.
@@ -38401,11 +38021,9 @@ components:
description: The version of the service that the service map should apply to.
type: string
sourcemap:
- description: >
+ description: |
The source map. String or file upload. It must follow the
-
- [source map revision 3
- proposal](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k).
+ [source map revision 3 proposal](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k).
format: binary
type: string
required:
@@ -38445,9 +38063,7 @@ components:
example: Not Found
type: string
message:
- example: >-
- Saved object [index-pattern/caaad6d0-920c-11ed-b36a-874bd1548a00]
- not found
+ example: Saved object [index-pattern/caaad6d0-920c-11ed-b36a-874bd1548a00] not found
type: string
statusCode:
enum:
@@ -38502,9 +38118,7 @@ components:
- title
override:
default: false
- description: >-
- Override an existing data view if a data view with the provided
- title already exists.
+ description: Override an existing data view if a data view with the provided title already exists.
type: boolean
required:
- data_view
@@ -38566,9 +38180,7 @@ components:
description: A map of field formats by field name.
type: object
Data_views_namespaces:
- description: >-
- An array of space identifiers for sharing the data view between multiple
- spaces.
+ description: An array of space identifiers for sharing the data view between multiple spaces.
items:
default: default
type: string
@@ -38620,9 +38232,8 @@ components:
description: The saved object reference to change.
type: string
fromType:
- description: >
- Specify the type of the saved object reference to alter. The default
- value is `index-pattern` for data views.
+ description: |
+ Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views.
type: string
toId:
description: New saved object reference value to replace the old value.
@@ -38634,17 +38245,13 @@ components:
description: The timestamp field name, which you use for time-based data views.
type: string
Data_views_title:
- description: >-
- Comma-separated list of data streams, indices, and aliases that you want
- to search. Supports wildcards (`*`).
+ description: Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (`*`).
type: string
Data_views_type:
description: When set to `rollup`, identifies the rollup data views.
type: string
Data_views_typemeta:
- description: >-
- When you use rollup indices, contains the field list for the rollup data
- view API endpoints.
+ description: When you use rollup indices, contains the field list for the rollup data view API endpoints.
type: object
properties:
aggs:
@@ -38657,9 +38264,7 @@ components:
- aggs
- params
Data_views_typemeta_response:
- description: >-
- When you use rollup indices, contains the field list for the rollup data
- view API endpoints.
+ description: When you use rollup indices, contains the field list for the rollup data view API endpoints.
nullable: true
type: object
properties:
@@ -38674,10 +38279,8 @@ components:
type: object
properties:
data_view:
- description: >
- 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.
+ description: |
+ 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.
type: object
properties:
allowNoIndex:
@@ -38737,10 +38340,7 @@ components:
- status
Kibana_HTTP_APIs_core_status_response:
additionalProperties: false
- description: >-
- Kibana's operational status as well as a detailed breakdown of plugin
- statuses indication of various loads (like event loop utilization and
- network traffic) at time of request.
+ description: Kibana's operational status as well as a detailed breakdown of plugin statuses indication of various loads (like event loop utilization and network traffic) at time of request.
type: object
properties:
metrics:
@@ -38799,9 +38399,7 @@ components:
description: A URL to further documentation regarding this service.
type: string
level:
- description: >-
- Service status levels as human and machine readable
- values.
+ description: Service status levels as human and machine readable values.
enum:
- available
- degraded
@@ -38810,9 +38408,7 @@ components:
type: string
meta:
additionalProperties: {}
- description: >-
- An unstructured set of extra metadata about this
- service.
+ description: An unstructured set of extra metadata about this service.
type: object
summary:
description: A human readable summary of the service status.
@@ -38832,9 +38428,7 @@ components:
description: A URL to further documentation regarding this service.
type: string
level:
- description: >-
- Service status levels as human and machine readable
- values.
+ description: Service status levels as human and machine readable values.
enum:
- available
- degraded
@@ -38843,9 +38437,7 @@ components:
type: string
meta:
additionalProperties: {}
- description: >-
- An unstructured set of extra metadata about this
- service.
+ description: An unstructured set of extra metadata about this service.
type: object
summary:
description: A human readable summary of the service status.
@@ -38898,9 +38490,7 @@ components:
description: A URL to further documentation regarding this service.
type: string
level:
- description: >-
- Service status levels as human and machine readable
- values.
+ description: Service status levels as human and machine readable values.
enum:
- available
- degraded
@@ -38925,9 +38515,7 @@ components:
- core
- plugins
uuid:
- description: >-
- Unique, generated Kibana instance UUID. This UUID should persist
- even if the Kibana process restarts.
+ description: Unique, generated Kibana instance UUID. This UUID should persist even if the Kibana process restarts.
type: string
version:
additionalProperties: false
@@ -38937,24 +38525,16 @@ components:
description: The date and time of this build.
type: string
build_flavor:
- description: >-
- The build flavour determines configuration and behavior of
- Kibana. On premise users will almost always run the
- "traditional" flavour, while other flavours are reserved for
- Elastic-specific use cases.
+ description: The build flavour determines configuration and behavior of Kibana. On premise users will almost always run the "traditional" flavour, while other flavours are reserved for Elastic-specific use cases.
enum:
- serverless
- traditional
type: string
build_hash:
- description: >-
- A unique hash value representing the git commit of this Kibana
- build.
+ description: A unique hash value representing the git commit of this Kibana build.
type: string
build_number:
- description: >-
- A monotonically increasing number, each subsequent build will
- have a higher number.
+ description: A monotonically increasing number, each subsequent build will have a higher number.
type: number
build_snapshot:
description: Whether this build is a snapshot build.
@@ -38980,25 +38560,17 @@ components:
datafeedsAdded:
additionalProperties:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseDatafeeds'
- description: >-
- If a saved object for an anomaly detection job is missing a datafeed
- identifier, it is added when you run the sync machine learning saved
- objects API.
+ description: If a saved object for an anomaly detection job is missing a datafeed identifier, it is added when you run the sync machine learning saved objects API.
type: object
datafeedsRemoved:
additionalProperties:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseDatafeeds'
- description: >-
- If a saved object for an anomaly detection job references a datafeed
- that no longer exists, it is deleted when you run the sync machine
- learning saved objects API.
+ description: If a saved object for an anomaly detection job references a datafeed that no longer exists, it is deleted when you run the sync machine learning saved objects API.
type: object
savedObjectsCreated:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseSavedObjectsCreated
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSavedObjectsCreated'
savedObjectsDeleted:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseSavedObjectsDeleted
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSavedObjectsDeleted'
title: Successful sync API response
type: object
Machine_learning_APIs_mlSync4xxResponse:
@@ -39014,97 +38586,63 @@ components:
title: Unsuccessful sync API response
type: object
Machine_learning_APIs_mlSyncResponseAnomalyDetectors:
- description: >-
- The sync machine learning saved objects API response contains this
- object when there are anomaly detection jobs affected by the
- synchronization. There is an object for each relevant job, which
- contains the synchronization status.
+ description: The sync machine learning saved objects API response contains this object when there are anomaly detection jobs affected by the synchronization. There is an object for each relevant job, which contains the synchronization status.
properties:
success:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSuccess'
title: Sync API response for anomaly detection jobs
type: object
Machine_learning_APIs_mlSyncResponseDatafeeds:
- description: >-
- The sync machine learning saved objects API response contains this
- object when there are datafeeds affected by the synchronization. There
- is an object for each relevant datafeed, which contains the
- synchronization status.
+ description: The sync machine learning saved objects API response contains this object when there are datafeeds affected by the synchronization. There is an object for each relevant datafeed, which contains the synchronization status.
properties:
success:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSuccess'
title: Sync API response for datafeeds
type: object
Machine_learning_APIs_mlSyncResponseDataFrameAnalytics:
- description: >-
- The sync machine learning saved objects API response contains this
- object when there are data frame analytics jobs affected by the
- synchronization. There is an object for each relevant job, which
- contains the synchronization status.
+ description: The sync machine learning saved objects API response contains this object when there are data frame analytics jobs affected by the synchronization. There is an object for each relevant job, which contains the synchronization status.
properties:
success:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSuccess'
title: Sync API response for data frame analytics jobs
type: object
Machine_learning_APIs_mlSyncResponseSavedObjectsCreated:
- description: >-
- If saved objects are missing for machine learning jobs or trained
- models, they are created when you run the sync machine learning saved
- objects API.
+ description: If saved objects are missing for machine learning jobs or trained models, they are created when you run the sync machine learning saved objects API.
properties:
anomaly-detector:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseAnomalyDetectors
- description: >-
- If saved objects are missing for anomaly detection jobs, they are
- created.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseAnomalyDetectors'
+ description: If saved objects are missing for anomaly detection jobs, they are created.
type: object
data-frame-analytics:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseDataFrameAnalytics
- description: >-
- If saved objects are missing for data frame analytics jobs, they are
- created.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseDataFrameAnalytics'
+ description: If saved objects are missing for data frame analytics jobs, they are created.
type: object
trained-model:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseTrainedModels
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseTrainedModels'
description: If saved objects are missing for trained models, they are created.
type: object
title: Sync API response for created saved objects
type: object
Machine_learning_APIs_mlSyncResponseSavedObjectsDeleted:
- description: >-
- If saved objects exist for machine learning jobs or trained models that
- no longer exist, they are deleted when you run the sync machine learning
- saved objects API.
+ description: If saved objects exist for machine learning jobs or trained models that no longer exist, they are deleted when you run the sync machine learning saved objects API.
properties:
anomaly-detector:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseAnomalyDetectors
- description: >-
- If there are saved objects exist for nonexistent anomaly detection
- jobs, they are deleted.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseAnomalyDetectors'
+ description: If there are saved objects exist for nonexistent anomaly detection jobs, they are deleted.
type: object
data-frame-analytics:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseDataFrameAnalytics
- description: >-
- If there are saved objects exist for nonexistent data frame
- analytics jobs, they are deleted.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseDataFrameAnalytics'
+ description: If there are saved objects exist for nonexistent data frame analytics jobs, they are deleted.
type: object
trained-model:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseTrainedModels
- description: >-
- If there are saved objects exist for nonexistent trained models,
- they are deleted.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseTrainedModels'
+ description: If there are saved objects exist for nonexistent trained models, they are deleted.
type: object
title: Sync API response for deleted saved objects
type: object
@@ -39112,11 +38650,7 @@ components:
description: The success or failure of the synchronization.
type: boolean
Machine_learning_APIs_mlSyncResponseTrainedModels:
- description: >-
- The sync machine learning saved objects API response contains this
- object when there are trained models affected by the synchronization.
- There is an object for each relevant trained model, which contains the
- synchronization status.
+ description: The sync machine learning saved objects API response contains this object when there are trained models affected by the synchronization. There is an object for each relevant trained model, which contains the synchronization status.
properties:
success:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSuccess'
@@ -39181,8 +38715,7 @@ components:
name:
type: string
skip_reason:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipReason
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipReason'
required:
- id
- skip_reason
@@ -39196,15 +38729,12 @@ components:
properties:
errors:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_NormalizedAnonymizationFieldError
+ $ref: '#/components/schemas/Security_AI_Assistant_API_NormalizedAnonymizationFieldError'
type: array
results:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResults
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResults'
summary:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_BulkCrudActionSummary
+ $ref: '#/components/schemas/Security_AI_Assistant_API_BulkCrudActionSummary'
required:
- results
- summary
@@ -39221,8 +38751,7 @@ components:
properties:
created:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse'
type: array
deleted:
items:
@@ -39230,13 +38759,11 @@ components:
type: array
skipped:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipResult
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipResult'
type: array
updated:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse'
type: array
required:
- updated
@@ -39444,11 +38971,8 @@ components:
type: object
properties:
confidence:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationConfidence
- description: >-
- How confident you are about this being a correct and useful
- learning.
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationConfidence'
+ description: How confident you are about this being a correct and useful learning.
content:
description: Summary text of the conversation over time.
type: string
@@ -39554,8 +39078,7 @@ components:
properties:
anonymization_fields:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldDetailsInError
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldDetailsInError'
type: array
err_code:
type: string
@@ -39576,8 +39099,7 @@ components:
type: string
prompts:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptDetailsInError
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptDetailsInError'
type: array
status_code:
type: integer
@@ -39676,8 +39198,7 @@ components:
name:
type: string
skip_reason:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptsBulkActionSkipReason
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptsBulkActionSkipReason'
required:
- id
- skip_reason
@@ -39689,15 +39210,12 @@ components:
properties:
errors:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_NormalizedPromptError
+ $ref: '#/components/schemas/Security_AI_Assistant_API_NormalizedPromptError'
type: array
results:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptsBulkCrudActionResults
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptsBulkCrudActionResults'
summary:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_BulkCrudActionSummary
+ $ref: '#/components/schemas/Security_AI_Assistant_API_BulkCrudActionSummary'
required:
- results
- summary
@@ -39724,8 +39242,7 @@ components:
type: array
skipped:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptsBulkActionSkipResult
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptsBulkActionSkipResult'
type: array
updated:
items:
@@ -39836,8 +39353,7 @@ components:
oneOf:
- $ref: '#/components/schemas/Security_Detections_API_AlertsSortCombinations'
- items:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsSortCombinations
+ $ref: '#/components/schemas/Security_Detections_API_AlertsSortCombinations'
type: array
Security_Detections_API_AlertsSortCombinations:
anyOf:
@@ -39855,21 +39371,18 @@ components:
type: object
properties:
duration:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertSuppressionDuration
+ $ref: '#/components/schemas/Security_Detections_API_AlertSuppressionDuration'
group_by:
$ref: '#/components/schemas/Security_Detections_API_AlertSuppressionGroupBy'
missing_fields_strategy:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertSuppressionMissingFieldsStrategy
+ $ref: '#/components/schemas/Security_Detections_API_AlertSuppressionMissingFieldsStrategy'
required:
- group_by
Security_Detections_API_AlertSuppressionDuration:
type: object
properties:
unit:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertSuppressionDurationUnit
+ $ref: '#/components/schemas/Security_Detections_API_AlertSuppressionDurationUnit'
value:
minimum: 1
type: integer
@@ -39889,12 +39402,9 @@ components:
minItems: 1
type: array
Security_Detections_API_AlertSuppressionMissingFieldsStrategy:
- description: >-
- Describes how alerts will be generated for documents with missing
- suppress by fields:
-
+ description: |-
+ Describes how alerts will be generated for documents with missing suppress by fields:
doNotSuppress - per each document a separate alert will be created
-
suppress - only alert will be created per suppress by bucket
enum:
- doNotSuppress
@@ -39911,26 +39421,16 @@ components:
minimum: 0
type: integer
Security_Detections_API_BuildingBlockType:
- description: >-
- Determines if the rule acts as a building block. By default,
- building-block alerts are not displayed in the UI. These rules are used
- as a foundation for other rules that do generate alerts. Its value must
- be default.
+ description: Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
type: string
Security_Detections_API_BulkActionEditPayload:
anyOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadTags
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadIndexPatterns
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadInvestigationFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadTimeline
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadRuleActions
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadSchedule
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadTags'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadIndexPatterns'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadInvestigationFields'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadTimeline'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadRuleActions'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadSchedule'
Security_Detections_API_BulkActionEditPayloadIndexPatterns:
type: object
properties:
@@ -39974,12 +39474,10 @@ components:
properties:
actions:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_NormalizedRuleAction
+ $ref: '#/components/schemas/Security_Detections_API_NormalizedRuleAction'
type: array
throttle:
- $ref: >-
- #/components/schemas/Security_Detections_API_ThrottleForBulkActions
+ $ref: '#/components/schemas/Security_Detections_API_ThrottleForBulkActions'
required:
- actions
required:
@@ -39996,9 +39494,7 @@ components:
type: object
properties:
interval:
- description: >-
- Interval in which the rule runs. For example, `"1h"` means the
- rule runs every hour.
+ description: Interval in which the rule runs. For example, `"1h"` means the rule runs every hour.
example: 1h
pattern: ^[1-9]\d*[smh]$
type: string
@@ -40040,8 +39536,7 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
required:
- timeline_id
- timeline_title
@@ -40143,15 +39638,12 @@ components:
properties:
errors:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_NormalizedRuleError
+ $ref: '#/components/schemas/Security_Detections_API_NormalizedRuleError'
type: array
results:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkEditActionResults
+ $ref: '#/components/schemas/Security_Detections_API_BulkEditActionResults'
summary:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkEditActionSummary
+ $ref: '#/components/schemas/Security_Detections_API_BulkEditActionSummary'
required:
- results
- summary
@@ -40393,11 +39885,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -40411,8 +39901,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -40428,24 +39917,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -40472,13 +39957,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -40521,11 +40004,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -40539,8 +40020,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -40556,24 +40036,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -40602,13 +40078,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -40644,11 +40118,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -40662,8 +40134,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -40681,24 +40152,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -40727,13 +40194,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -40752,11 +40217,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -40770,8 +40233,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -40789,24 +40251,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -40835,13 +40293,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -40892,11 +40348,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -40910,8 +40364,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -40927,24 +40380,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -40971,13 +40420,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -41020,11 +40467,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -41038,8 +40483,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -41055,24 +40499,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -41101,13 +40541,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -41132,11 +40570,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -41150,8 +40586,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -41171,13 +40606,11 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
query:
@@ -41186,12 +40619,10 @@ components:
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -41220,13 +40651,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
type:
@@ -41267,11 +40696,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -41285,8 +40712,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -41304,24 +40730,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -41350,13 +40772,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -41381,14 +40801,11 @@ components:
- endpoint_blocklists
type: string
Security_Detections_API_ExternalRuleSource:
- description: >-
- Type of rule source for externally sourced rules, i.e. rules that have
- an external source, such as the Elastic Prebuilt rules repo.
+ description: Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
type: object
properties:
is_customized:
- $ref: >-
- #/components/schemas/Security_Detections_API_IsExternalRuleCustomized
+ $ref: '#/components/schemas/Security_Detections_API_IsExternalRuleCustomized'
type:
enum:
- external
@@ -41420,9 +40837,7 @@ components:
type: string
type: array
Security_Detections_API_InternalRuleSource:
- description: >-
- Type of rule source for internally sourced rules, i.e. created within
- the Kibana apps.
+ description: Type of rule source for internally sourced rules, i.e. created within the Kibana apps.
type: object
properties:
type:
@@ -41432,33 +40847,19 @@ components:
required:
- type
Security_Detections_API_InvestigationFields:
- description: >
- Schema for fields relating to investigation fields. These are user
- defined fields we use to highlight
-
- in various features in the UI such as alert details flyout and
- exceptions auto-population from alert.
-
+ description: |
+ Schema for fields relating to investigation fields. These are user defined fields we use to highlight
+ in various features in the UI such as alert details flyout and exceptions auto-population from alert.
Added in PR #163235
-
- Right now we only have a single field but anticipate adding more related
- fields to store various
-
- configuration states such as `override` - where a user might say if they
- want only these fields to
-
- display, or if they want these fields + the fields we select. When
- expanding this field, it may look
-
+ Right now we only have a single field but anticipate adding more related fields to store various
+ configuration states such as `override` - where a user might say if they want only these fields to
+ display, or if they want these fields + the fields we select. When expanding this field, it may look
something like:
-
```typescript
-
const investigationFields = z.object({
field_names: NonEmptyArray(NonEmptyString),
override: z.boolean().optional(),
});
-
```
type: object
properties:
@@ -41473,19 +40874,14 @@ components:
description: Notes to help investigate alerts produced by the rule.
type: string
Security_Detections_API_IsExternalRuleCustomized:
- description: >-
- Determines whether an external/prebuilt rule has been customized by the
- user (i.e. any of its fields have been modified and diverged from the
- base value).
+ description: Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
type: boolean
Security_Detections_API_IsRuleEnabled:
description: Determines whether the rule is enabled.
type: boolean
Security_Detections_API_IsRuleImmutable:
deprecated: true
- description: >-
- This field determines whether the rule is a prebuilt Elastic rule. It
- will be replaced with the `rule_source` field.
+ description: This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the `rule_source` field.
type: boolean
Security_Detections_API_ItemsPerSearch:
minimum: 1
@@ -41512,11 +40908,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -41530,8 +40924,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -41547,24 +40940,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -41591,13 +40980,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -41626,14 +41013,11 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleResponseFields'
Security_Detections_API_MachineLearningRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields'
Security_Detections_API_MachineLearningRuleCreateProps:
allOf:
- type: object
@@ -41643,11 +41027,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -41661,8 +41043,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -41678,24 +41059,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -41724,13 +41101,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -41740,8 +41115,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleCreateFields'
Security_Detections_API_MachineLearningRuleOptionalFields:
type: object
properties:
@@ -41754,15 +41128,13 @@ components:
anomaly_threshold:
$ref: '#/components/schemas/Security_Detections_API_AnomalyThreshold'
machine_learning_job_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningJobId
+ $ref: '#/components/schemas/Security_Detections_API_MachineLearningJobId'
type:
description: Rule type
enum:
- machine_learning
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields'
Security_Detections_API_MachineLearningRulePatchProps:
allOf:
- type: object
@@ -41772,11 +41144,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -41790,8 +41160,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -41809,24 +41178,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -41855,19 +41220,16 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
$ref: '#/components/schemas/Security_Detections_API_RuleVersion'
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRulePatchFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRulePatchFields'
Security_Detections_API_MachineLearningRuleRequiredFields:
type: object
properties:
@@ -41886,10 +41248,8 @@ components:
- anomaly_threshold
Security_Detections_API_MachineLearningRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields'
Security_Detections_API_MachineLearningRuleUpdateProps:
allOf:
- type: object
@@ -41899,11 +41259,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -41917,8 +41275,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -41936,24 +41293,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -41982,13 +41335,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -41998,8 +41349,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleCreateFields'
Security_Detections_API_MaxSignals:
minimum: 1
type: integer
@@ -42018,11 +41368,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -42036,8 +41384,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -42053,24 +41400,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -42097,13 +41440,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -42132,16 +41473,12 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleResponseFields'
Security_Detections_API_NewTermsRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleDefaultableFields'
Security_Detections_API_NewTermsRuleCreateProps:
allOf:
- type: object
@@ -42151,11 +41488,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -42169,8 +41504,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -42186,24 +41520,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -42232,13 +41562,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -42248,8 +41576,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleCreateFields'
Security_Detections_API_NewTermsRuleDefaultableFields:
type: object
properties:
@@ -42281,10 +41608,8 @@ components:
enum:
- new_terms
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleDefaultableFields'
Security_Detections_API_NewTermsRulePatchProps:
allOf:
- type: object
@@ -42294,11 +41619,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -42312,8 +41635,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -42331,24 +41653,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -42377,13 +41695,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -42410,10 +41726,8 @@ components:
- history_window_start
Security_Detections_API_NewTermsRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields'
- type: object
properties:
language:
@@ -42429,11 +41743,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -42447,8 +41759,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -42466,24 +41777,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -42512,13 +41819,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -42528,8 +41833,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleCreateFields'
Security_Detections_API_NonEmptyString:
description: A string that is not empty and does not contain only whitespace
minLength: 1
@@ -42556,8 +41860,7 @@ components:
type: object
properties:
err_code:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionsDryRunErrCode
+ $ref: '#/components/schemas/Security_Detections_API_BulkActionsDryRunErrCode'
message:
type: string
rules:
@@ -42669,11 +41972,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -42687,8 +41988,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -42704,24 +42004,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -42748,13 +42044,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -42788,8 +42082,7 @@ components:
allOf:
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleRequiredFields'
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleOptionalFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_QueryRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_QueryRuleDefaultableFields'
Security_Detections_API_QueryRuleCreateProps:
allOf:
- type: object
@@ -42799,11 +42092,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -42817,8 +42108,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -42834,24 +42124,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -42880,13 +42166,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -42927,8 +42211,7 @@ components:
- query
type: string
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleOptionalFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_QueryRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_QueryRuleDefaultableFields'
Security_Detections_API_QueryRulePatchProps:
allOf:
- type: object
@@ -42938,11 +42221,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -42956,8 +42237,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -42975,24 +42255,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -43021,13 +42297,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -43065,11 +42339,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -43083,8 +42355,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -43102,24 +42373,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -43148,13 +42415,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -43166,58 +42431,32 @@ components:
- severity
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleCreateFields'
Security_Detections_API_RelatedIntegration:
- description: >
- Related integration is a potential dependency of a rule. It's assumed
- that if the user installs
-
- one of the related integrations of a rule, the rule might start to work
- properly because it will
-
- have source events (generated by this integration) potentially matching
- the rule's query.
-
-
- NOTE: Proper work is not guaranteed, because a related integration, if
- installed, can be
-
- configured differently or generate data that is not necessarily relevant
- for this rule.
-
-
- Related integration is a combination of a Fleet package and (optionally)
- one of the
+ description: |
+ Related integration is a potential dependency of a rule. It's assumed that if the user installs
+ one of the related integrations of a rule, the rule might start to work properly because it will
+ have source events (generated by this integration) potentially matching the rule's query.
- package's "integrations" that this package contains. It is represented
- by 3 properties:
+ NOTE: Proper work is not guaranteed, because a related integration, if installed, can be
+ configured differently or generate data that is not necessarily relevant for this rule.
+ Related integration is a combination of a Fleet package and (optionally) one of the
+ package's "integrations" that this package contains. It is represented by 3 properties:
- `package`: name of the package (required, unique id)
-
- `version`: version of the package (required, semver-compatible)
+ - `integration`: name of the integration of this package (optional, id within the package)
- - `integration`: name of the integration of this package (optional, id
- within the package)
-
-
- There are Fleet packages like `windows` that contain only one
- integration; in this case,
-
- `integration` should be unspecified. There are also packages like `aws`
- and `azure` that contain
-
+ There are Fleet packages like `windows` that contain only one integration; in this case,
+ `integration` should be unspecified. There are also packages like `aws` and `azure` that contain
several integrations; in this case, `integration` should be specified.
-
@example
-
const x: RelatedIntegration = {
package: 'windows',
version: '1.5.x',
};
-
@example
-
const x: RelatedIntegration = {
package: 'azure',
version: '~1.1.6',
@@ -43239,35 +42478,23 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RelatedIntegration'
type: array
Security_Detections_API_RequiredField:
- description: >
- Describes an Elasticsearch field that is needed for the rule to
- function.
-
-
- Almost all types of Security rules check source event documents for a
- match to some kind of
-
- query or filter. If a document has certain field with certain values,
- then it's a match and
+ description: |
+ Describes an Elasticsearch field that is needed for the rule to function.
+ Almost all types of Security rules check source event documents for a match to some kind of
+ query or filter. If a document has certain field with certain values, then it's a match and
the rule will generate an alert.
-
- Required field is an event field that must be present in the source
- indices of a given rule.
-
+ Required field is an event field that must be present in the source indices of a given rule.
@example
-
const standardEcsField: RequiredField = {
name: 'event.action',
type: 'keyword',
ecs: true,
};
-
@example
-
const nonEcsField: RequiredField = {
name: 'winlog.event_data.AttributeLDAPDisplayName',
type: 'keyword',
@@ -43293,10 +42520,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RequiredField'
type: array
Security_Detections_API_RequiredFieldInput:
- description: >-
- Input parameters to create a RequiredField. Does not include the `ecs`
- field, because `ecs` is calculated on the backend based on the field
- name and type.
+ description: Input parameters to create a RequiredField. Does not include the `ecs` field, because `ecs` is calculated on the backend based on the field name and type.
type: object
properties:
name:
@@ -43358,9 +42582,7 @@ components:
minimum: 0
type: integer
Security_Detections_API_RiskScoreMapping:
- description: >-
- Overrides generated alerts' risk_score with a value from the source
- event
+ description: Overrides generated alerts' risk_score with a value from the source event
items:
type: object
properties:
@@ -43405,17 +42627,13 @@ components:
additionalProperties: true
type: object
Security_Detections_API_RuleActionFrequency:
- description: >-
- The action frequency defines when the action runs (for example, only on
- rule execution or at specific time intervals).
+ description: The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
type: object
properties:
notifyWhen:
$ref: '#/components/schemas/Security_Detections_API_RuleActionNotifyWhen'
summary:
- description: >-
- Action summary indicates whether we will send a summary notification
- about all the generate alerts or notification per individual alert
+ description: Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
type: boolean
throttle:
$ref: '#/components/schemas/Security_Detections_API_RuleActionThrottle'
@@ -43425,17 +42643,13 @@ components:
- notifyWhen
- throttle
Security_Detections_API_RuleActionGroup:
- description: >-
- Optionally groups actions by use cases. Use `default` for alert
- notifications.
+ description: Optionally groups actions by use cases. Use `default` for alert notifications.
type: string
Security_Detections_API_RuleActionId:
description: The connector ID.
type: string
Security_Detections_API_RuleActionNotifyWhen:
- description: >-
- The condition for throttling the notification: `onActionGroupChange`,
- `onActiveAlert`, or `onThrottleInterval`
+ description: 'The condition for throttling the notification: `onActionGroupChange`, `onActiveAlert`, or `onThrottleInterval`'
enum:
- onActiveAlert
- onThrottleInterval
@@ -43443,9 +42657,7 @@ components:
type: string
Security_Detections_API_RuleActionParams:
additionalProperties: true
- description: >-
- Object containing the allowed connector fields, which varies according
- to the connector type.
+ description: Object containing the allowed connector fields, which varies according to the connector type.
type: object
Security_Detections_API_RuleActionThrottle:
description: Defines how often rule actions are taken.
@@ -43466,14 +42678,10 @@ components:
anyOf:
- $ref: '#/components/schemas/Security_Detections_API_EqlRuleCreateProps'
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleCreateProps'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleCreateProps
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleCreateProps'
- $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleCreateProps'
- $ref: '#/components/schemas/Security_Detections_API_EsqlRuleCreateProps'
discriminator:
@@ -43520,50 +42728,25 @@ components:
minimum: 0
type: integer
total_enrichment_duration_ms:
- description: >-
- Total time spent enriching documents during current rule execution
- cycle
+ description: Total time spent enriching documents during current rule execution cycle
minimum: 0
type: integer
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during current rule execution
- cycle
+ description: Total time spent indexing documents during current rule execution cycle
minimum: 0
type: integer
total_search_duration_ms:
- description: >-
- Total time spent performing ES searches as measured by Kibana;
- includes network latency and time spent serializing/deserializing
- request/response
+ description: Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
minimum: 0
type: integer
Security_Detections_API_RuleExecutionStatus:
- description: >-
- Custom execution status of Security rules that is different from the
- status used in the Alerting Framework. We merge our custom status with
- the Framework's status to determine the resulting status of a rule.
-
- - going to run - @deprecated Replaced by the 'running' status but left
- for backwards compatibility with rule execution events already written
- to Event Log in the prior versions of Kibana. Don't use when writing
- rule status changes.
-
- - running - Rule execution started but not reached any intermediate or
- final status.
-
- - partial failure - Rule can partially fail for various reasons either
- in the middle of an execution (in this case we update its status right
- away) or in the end of it. So currently this status can be both
- intermediate and final at the same time. A typical reason for a partial
- failure: not all the indices that the rule searches over actually exist.
-
- - failed - Rule failed to execute due to unhandled exception or a reason
- defined in the business logic of its executor function.
-
- - succeeded - Rule executed successfully without any issues. Note: this
- status is just an indication of a rule's "health". The rule might or
- might not generate any alerts despite of it.
+ description: |-
+ Custom execution status of Security rules that is different from the status used in the Alerting Framework. We merge our custom status with the Framework's status to determine the resulting status of a rule.
+ - going to run - @deprecated Replaced by the 'running' status but left for backwards compatibility with rule execution events already written to Event Log in the prior versions of Kibana. Don't use when writing rule status changes.
+ - running - Rule execution started but not reached any intermediate or final status.
+ - partial failure - Rule can partially fail for various reasons either in the middle of an execution (in this case we update its status right away) or in the end of it. So currently this status can be both intermediate and final at the same time. A typical reason for a partial failure: not all the indices that the rule searches over actually exist.
+ - failed - Rule failed to execute due to unhandled exception or a reason defined in the business logic of its executor function.
+ - succeeded - Rule executed successfully without any issues. Note: this status is just an indication of a rule's "health". The rule might or might not generate any alerts despite of it.
enum:
- going to run
- running
@@ -43586,14 +42769,12 @@ components:
message:
type: string
metrics:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleExecutionMetrics
+ $ref: '#/components/schemas/Security_Detections_API_RuleExecutionMetrics'
status:
$ref: '#/components/schemas/Security_Detections_API_RuleExecutionStatus'
description: Status of the last execution
status_order:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleExecutionStatusOrder
+ $ref: '#/components/schemas/Security_Detections_API_RuleExecutionStatusOrder'
required:
- date
- status
@@ -43610,16 +42791,10 @@ components:
items: {}
type: array
Security_Detections_API_RuleInterval:
- description: >-
- Frequency of rule execution, using a date math range. For example, "1h"
- means the rule runs every hour. Defaults to 5m (5 minutes).
+ description: Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
type: string
Security_Detections_API_RuleIntervalFrom:
- description: >-
- Time from which data is analyzed each time the rule runs, using a date
- math range. For example, now-4200s means the rule analyzes data from 70
- minutes before its start time. Defaults to now-6m (analyzes data from 6
- minutes before the start time).
+ description: Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
format: date-math
type: string
Security_Detections_API_RuleIntervalTo:
@@ -43642,13 +42817,10 @@ components:
anyOf:
- $ref: '#/components/schemas/Security_Detections_API_EqlRulePatchProps'
- $ref: '#/components/schemas/Security_Detections_API_QueryRulePatchProps'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRulePatchProps
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRulePatchProps'
- $ref: '#/components/schemas/Security_Detections_API_ThresholdRulePatchProps'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRulePatchProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRulePatchProps
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRulePatchProps'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRulePatchProps'
- $ref: '#/components/schemas/Security_Detections_API_NewTermsRulePatchProps'
- $ref: '#/components/schemas/Security_Detections_API_EsqlRulePatchProps'
Security_Detections_API_RulePreviewLoggedRequest:
@@ -43674,8 +42846,7 @@ components:
type: array
requests:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewLoggedRequest
+ $ref: '#/components/schemas/Security_Detections_API_RulePreviewLoggedRequest'
type: array
startedAt:
$ref: '#/components/schemas/Security_Detections_API_NonEmptyString'
@@ -43720,19 +42891,14 @@ components:
description: Could be any string, not necessarily a UUID
type: string
Security_Detections_API_RuleSource:
- description: >-
- Discriminated union that determines whether the rule is internally
- sourced (created within the Kibana app) or has an external source, such
- as the Elastic Prebuilt rules repo.
+ description: Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
discriminator:
propertyName: type
oneOf:
- $ref: '#/components/schemas/Security_Detections_API_ExternalRuleSource'
- $ref: '#/components/schemas/Security_Detections_API_InternalRuleSource'
Security_Detections_API_RuleTagArray:
- description: >-
- String array containing words and phrases to help categorize, filter,
- and search rules. Defaults to an empty array.
+ description: String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
items:
type: string
type: array
@@ -43740,14 +42906,10 @@ components:
anyOf:
- $ref: '#/components/schemas/Security_Detections_API_EqlRuleUpdateProps'
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleUpdateProps'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleUpdateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleUpdateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleUpdateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleUpdateProps
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleUpdateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleUpdateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleUpdateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleUpdateProps'
- $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleUpdateProps'
- $ref: '#/components/schemas/Security_Detections_API_EsqlRuleUpdateProps'
discriminator:
@@ -43780,11 +42942,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -43798,8 +42958,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -43815,24 +42974,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -43859,13 +43014,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -43894,16 +43047,12 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleResponseFields'
Security_Detections_API_SavedQueryRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleDefaultableFields'
Security_Detections_API_SavedQueryRuleCreateProps:
allOf:
- type: object
@@ -43913,11 +43062,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -43931,8 +43078,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -43948,24 +43094,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -43994,13 +43136,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -44010,8 +43150,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleCreateFields'
Security_Detections_API_SavedQueryRuleDefaultableFields:
type: object
properties:
@@ -44041,10 +43180,8 @@ components:
enum:
- saved_query
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleDefaultableFields'
Security_Detections_API_SavedQueryRulePatchProps:
allOf:
- type: object
@@ -44054,11 +43191,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -44072,8 +43207,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -44091,24 +43225,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -44137,19 +43267,16 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
$ref: '#/components/schemas/Security_Detections_API_RuleVersion'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRulePatchFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRulePatchFields'
Security_Detections_API_SavedQueryRuleRequiredFields:
type: object
properties:
@@ -44165,10 +43292,8 @@ components:
- saved_id
Security_Detections_API_SavedQueryRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields'
- type: object
properties:
language:
@@ -44184,11 +43309,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -44202,8 +43325,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -44221,24 +43343,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -44267,13 +43385,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -44283,8 +43399,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleCreateFields'
Security_Detections_API_SetAlertsStatusByIds:
type: object
properties:
@@ -44393,18 +43508,14 @@ components:
type: array
Security_Detections_API_ThreatFilters:
items:
- description: >-
- Query and filter context array used to filter documents from the
- Elasticsearch index containing the threat values
+ description: Query and filter context array used to filter documents from the Elasticsearch index containing the threat values
type: array
Security_Detections_API_ThreatIndex:
items:
type: string
type: array
Security_Detections_API_ThreatIndicatorPath:
- description: >-
- Defines the path to the threat indicator in the indicator documents
- (optional)
+ description: Defines the path to the threat indicator in the indicator documents (optional)
type: string
Security_Detections_API_ThreatMapping:
items:
@@ -44440,11 +43551,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -44458,8 +43567,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -44475,24 +43583,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -44519,13 +43623,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -44554,16 +43656,12 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleResponseFields'
Security_Detections_API_ThreatMatchRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleDefaultableFields'
Security_Detections_API_ThreatMatchRuleCreateProps:
allOf:
- type: object
@@ -44573,11 +43671,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -44591,8 +43687,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -44608,24 +43703,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -44654,13 +43745,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -44670,8 +43759,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleCreateFields'
Security_Detections_API_ThreatMatchRuleDefaultableFields:
type: object
properties:
@@ -44717,10 +43805,8 @@ components:
enum:
- threat_match
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleDefaultableFields'
Security_Detections_API_ThreatMatchRulePatchProps:
allOf:
- type: object
@@ -44730,11 +43816,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -44748,8 +43832,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -44767,24 +43850,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -44813,19 +43892,16 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
$ref: '#/components/schemas/Security_Detections_API_RuleVersion'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRulePatchFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRulePatchFields'
Security_Detections_API_ThreatMatchRuleRequiredFields:
type: object
properties:
@@ -44850,10 +43926,8 @@ components:
- threat_index
Security_Detections_API_ThreatMatchRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields'
- type: object
properties:
language:
@@ -44869,11 +43943,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -44887,8 +43959,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -44906,24 +43977,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -44952,13 +44019,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -44968,8 +44033,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleCreateFields'
Security_Detections_API_ThreatQuery:
description: Query to run
type: string
@@ -45042,8 +44106,7 @@ components:
type: object
properties:
duration:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertSuppressionDuration
+ $ref: '#/components/schemas/Security_Detections_API_AlertSuppressionDuration'
required:
- duration
Security_Detections_API_ThresholdCardinality:
@@ -45075,11 +44138,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -45093,8 +44154,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -45110,24 +44170,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -45154,13 +44210,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -45189,16 +44243,12 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleResponseFields'
Security_Detections_API_ThresholdRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleDefaultableFields'
Security_Detections_API_ThresholdRuleCreateProps:
allOf:
- type: object
@@ -45208,11 +44258,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -45226,8 +44274,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -45243,24 +44290,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -45289,13 +44332,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -45305,8 +44346,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleCreateFields'
Security_Detections_API_ThresholdRuleDefaultableFields:
type: object
properties:
@@ -45316,8 +44356,7 @@ components:
type: object
properties:
alert_suppression:
- $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdAlertSuppression
+ $ref: '#/components/schemas/Security_Detections_API_ThresholdAlertSuppression'
data_view_id:
$ref: '#/components/schemas/Security_Detections_API_DataViewId'
filters:
@@ -45339,10 +44378,8 @@ components:
enum:
- threshold
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleDefaultableFields'
Security_Detections_API_ThresholdRulePatchProps:
allOf:
- type: object
@@ -45352,11 +44389,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -45370,8 +44405,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -45389,24 +44423,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -45435,19 +44465,16 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
$ref: '#/components/schemas/Security_Detections_API_RuleVersion'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRulePatchFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRulePatchFields'
Security_Detections_API_ThresholdRuleRequiredFields:
type: object
properties:
@@ -45466,10 +44493,8 @@ components:
- threshold
Security_Detections_API_ThresholdRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields'
- type: object
properties:
language:
@@ -45485,11 +44510,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -45503,8 +44526,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -45522,24 +44544,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -45568,13 +44586,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -45584,16 +44600,13 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleCreateFields'
Security_Detections_API_ThresholdValue:
description: Threshold value
minimum: 1
type: integer
Security_Detections_API_ThrottleForBulkActions:
- description: >-
- The condition for throttling the notification: 'rule', 'no_actions', or
- time duration
+ description: 'The condition for throttling the notification: ''rule'', ''no_actions'', or time duration'
enum:
- rule
- 1h
@@ -45655,44 +44668,34 @@ components:
created_by:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListDescription'
id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListId'
immutable:
type: boolean
list_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListMeta
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListMeta'
name:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListName
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionNamespaceType'
os_types:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsTypeArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsTypeArray'
tags:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListTags
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListTags'
tie_breaker_id:
type: string
type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListType'
updated_at:
format: date-time
type: string
updated_by:
type: string
version:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListVersion
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListVersion'
required:
- id
- list_id
@@ -45720,51 +44723,39 @@ components:
_version:
type: string
comments:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray'
created_at:
format: date-time
type: string
created_by:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId'
item_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
list_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionNamespaceType'
os_types:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray'
tags:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags'
tie_breaker_id:
type: string
type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType'
updated_at:
format: date-time
type: string
@@ -45809,31 +44800,23 @@ components:
- created_by
Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemComment
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemComment'
type: array
Security_Endpoint_Exceptions_API_ExceptionListItemDescription:
type: string
Security_Endpoint_Exceptions_API_ExceptionListItemEntry:
anyOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryList
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryNested
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchWildcard
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryList'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryNested'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchWildcard'
discriminator:
propertyName: type
Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntry
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntry'
type: array
Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists:
type: object
@@ -45841,8 +44824,7 @@ components:
field:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- exists
@@ -45867,8 +44849,7 @@ components:
- id
- type
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- list
@@ -45884,8 +44865,7 @@ components:
field:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- match
@@ -45903,16 +44883,14 @@ components:
field:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- match_any
type: string
value:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
minItems: 1
type: array
required:
@@ -45926,8 +44904,7 @@ components:
field:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- wildcard
@@ -45944,8 +44921,7 @@ components:
properties:
entries:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryNestedEntryItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryNestedEntryItem'
minItems: 1
type: array
field:
@@ -45960,12 +44936,9 @@ components:
- entries
Security_Endpoint_Exceptions_API_ExceptionListItemEntryNestedEntryItem:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists'
Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator:
enum:
- excluded
@@ -45982,8 +44955,7 @@ components:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsType'
type: array
Security_Endpoint_Exceptions_API_ExceptionListItemTags:
items:
@@ -46006,8 +44978,7 @@ components:
type: string
Security_Endpoint_Exceptions_API_ExceptionListOsTypeArray:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsType'
type: array
Security_Endpoint_Exceptions_API_ExceptionListTags:
items:
@@ -46027,15 +44998,11 @@ components:
minimum: 1
type: integer
Security_Endpoint_Exceptions_API_ExceptionNamespaceType:
- description: >
- Determines whether the exception container is available in all Kibana
- spaces or just the space
-
+ description: |
+ Determines whether the exception container is available in all Kibana spaces or just the space
in which it is created, where:
-
- `single`: Only available in the Kibana space in which it is created.
-
- `agnostic`: Available in all Kibana spaces.
enum:
- agnostic
@@ -46124,11 +45091,9 @@ components:
type: object
properties:
agent_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_AgentId
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_AgentId'
pending_actions:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionsSchema
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionsSchema'
required:
- agent_id
- pending_actions
@@ -46219,8 +45184,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -46231,11 +45195,9 @@ components:
type: object
properties:
command:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_Command
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_Command'
timeout:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_Timeout
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_Timeout'
required:
- command
required:
@@ -46280,8 +45242,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -46298,11 +45259,9 @@ components:
required:
- parameters
Security_Endpoint_Management_API_GetProcessesRouteRequestBody:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
Security_Endpoint_Management_API_IsolateRouteRequestBody:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
Security_Endpoint_Management_API_KillProcessRouteRequestBody:
allOf:
- type: object
@@ -46316,8 +45275,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -46327,8 +45285,7 @@ components:
parameters:
oneOf:
- $ref: '#/components/schemas/Security_Endpoint_Management_API_Pid'
- - $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EntityId
+ - $ref: '#/components/schemas/Security_Endpoint_Management_API_EntityId'
- type: object
properties:
process_name:
@@ -46404,8 +45361,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -46427,32 +45383,23 @@ components:
- type: object
properties:
execute:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
get-file:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
isolate:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
kill-process:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
running-processes:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
scan:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
suspend-process:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
unisolate:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
upload:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
- additionalProperties: true
type: object
Security_Endpoint_Management_API_Pid:
@@ -46479,8 +45426,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -46515,8 +45461,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -46526,8 +45471,7 @@ components:
parameters:
oneOf:
- $ref: '#/components/schemas/Security_Endpoint_Management_API_Pid'
- - $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EntityId
+ - $ref: '#/components/schemas/Security_Endpoint_Management_API_EntityId'
required:
- parameters
Security_Endpoint_Management_API_Timeout:
@@ -46548,8 +45492,7 @@ components:
minLength: 1
type: array
Security_Endpoint_Management_API_UnisolateRouteRequestBody:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
Security_Endpoint_Management_API_UploadRouteRequestBody:
allOf:
- type: object
@@ -46563,8 +45506,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -46636,10 +45578,8 @@ components:
type: string
Security_Entity_Analytics_API_AssetCriticalityRecord:
allOf:
- - $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord
- - $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecordEcsParts
+ - $ref: '#/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord'
+ - $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecordEcsParts'
- type: object
properties:
'@timestamp':
@@ -46656,8 +45596,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- asset
host:
@@ -46667,8 +45606,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality
name:
@@ -46682,8 +45620,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality
name:
@@ -46728,13 +45665,11 @@ components:
- errors
Security_Entity_Analytics_API_CreateAssetCriticalityRecord:
allOf:
- - $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecordIdParts
+ - $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecordIdParts'
- type: object
properties:
criticality_level:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality_level
Security_Entity_Analytics_API_EngineDataviewUpdateResult:
@@ -46808,23 +45743,17 @@ components:
format: double
type: number
calculated_score_norm:
- description: >-
- The normalized numeric value of the given entity's risk score.
- Useful for comparing with other entities.
+ description: The normalized numeric value of the given entity's risk score. Useful for comparing with other entities.
format: double
maximum: 100
minimum: 0
type: number
category_1_count:
- description: >-
- The number of risk input documents that contributed to the Category
- 1 score (`category_1_score`).
+ description: The number of risk input documents that contributed to the Category 1 score (`category_1_score`).
format: integer
type: number
category_1_score:
- description: >-
- The contribution of Category 1 to the overall risk score
- (`calculated_score`). Category 1 contains Detection Engine Alerts.
+ description: The contribution of Category 1 to the overall risk score (`calculated_score`). Category 1 contains Detection Engine Alerts.
format: double
type: number
category_2_count:
@@ -46834,27 +45763,20 @@ components:
format: double
type: number
criticality_level:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
criticality_modifier:
format: double
type: number
id_field:
- description: >-
- The identifier field defining this risk score. Coupled with
- `id_value`, uniquely identifies the entity being scored.
+ description: The identifier field defining this risk score. Coupled with `id_value`, uniquely identifies the entity being scored.
example: host.name
type: string
id_value:
- description: >-
- The identifier value defining this risk score. Coupled with
- `id_field`, uniquely identifies the entity being scored.
+ description: The identifier value defining this risk score. Coupled with `id_field`, uniquely identifies the entity being scored.
example: example.host
type: string
inputs:
- description: >-
- A list of the highest-risk documents contributing to this risk
- score. Useful for investigative purposes.
+ description: A list of the highest-risk documents contributing to this risk score. Useful for investigative purposes.
items:
$ref: '#/components/schemas/Security_Entity_Analytics_API_RiskScoreInput'
type: array
@@ -46888,8 +45810,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality
entity:
@@ -46932,8 +45853,7 @@ components:
name:
type: string
risk:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EntityRiskScoreRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EntityRiskScoreRecord'
type:
items:
type: string
@@ -47018,6 +45938,14 @@ components:
- index
- description
- category
+ Security_Entity_Analytics_API_StoreStatus:
+ enum:
+ - not_installed
+ - installing
+ - running
+ - stopped
+ - error
+ type: string
Security_Entity_Analytics_API_TaskManagerUnavailableResponse:
description: Task manager is unavailable
type: object
@@ -47040,8 +45968,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality
entity:
@@ -47080,8 +46007,7 @@ components:
name:
type: string
risk:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EntityRiskScoreRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EntityRiskScoreRecord'
roles:
items:
type: string
@@ -47101,8 +46027,7 @@ components:
- comment
Security_Exceptions_API_CreateExceptionListItemCommentArray:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateExceptionListItemComment
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateExceptionListItemComment'
type: array
Security_Exceptions_API_CreateRuleExceptionListItemComment:
type: object
@@ -47113,28 +46038,23 @@ components:
- comment
Security_Exceptions_API_CreateRuleExceptionListItemCommentArray:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemComment
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemComment'
type: array
Security_Exceptions_API_CreateRuleExceptionListItemProps:
type: object
properties:
comments:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
meta:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemMeta'
name:
@@ -47143,8 +46063,7 @@ components:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemTags'
@@ -47167,8 +46086,7 @@ components:
created_by:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListDescription'
id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListId'
immutable:
@@ -47182,8 +46100,7 @@ components:
namespace_type:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray'
tags:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListTags'
tie_breaker_id:
@@ -47224,27 +46141,23 @@ components:
_version:
type: string
comments:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemCommentArray'
created_at:
format: date-time
type: string
created_by:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemId'
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
list_id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
@@ -47254,8 +46167,7 @@ components:
namespace_type:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray'
tags:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemTags'
tie_breaker_id:
@@ -47312,18 +46224,12 @@ components:
type: string
Security_Exceptions_API_ExceptionListItemEntry:
anyOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatch
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchAny
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryList
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryExists
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryNested
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchWildcard
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatch'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchAny'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryList'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryExists'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryNested'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchWildcard'
discriminator:
propertyName: type
Security_Exceptions_API_ExceptionListItemEntryArray:
@@ -47336,8 +46242,7 @@ components:
field:
$ref: '#/components/schemas/Security_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- exists
@@ -47362,8 +46267,7 @@ components:
- id
- type
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- list
@@ -47379,8 +46283,7 @@ components:
field:
$ref: '#/components/schemas/Security_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- match
@@ -47398,8 +46301,7 @@ components:
field:
$ref: '#/components/schemas/Security_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- match_any
@@ -47420,8 +46322,7 @@ components:
field:
$ref: '#/components/schemas/Security_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- wildcard
@@ -47438,8 +46339,7 @@ components:
properties:
entries:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryNestedEntryItem
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryNestedEntryItem'
minItems: 1
type: array
field:
@@ -47454,12 +46354,9 @@ components:
- entries
Security_Exceptions_API_ExceptionListItemEntryNestedEntryItem:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatch
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchAny
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryExists
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatch'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchAny'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryExists'
Security_Exceptions_API_ExceptionListItemEntryOperator:
enum:
- excluded
@@ -47517,16 +46414,14 @@ components:
id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListId'
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
list_id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
required:
- error
Security_Exceptions_API_ExceptionListsImportBulkErrorArray:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListsImportBulkError
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListsImportBulkError'
type: array
Security_Exceptions_API_ExceptionListTags:
items:
@@ -47546,15 +46441,11 @@ components:
minimum: 1
type: integer
Security_Exceptions_API_ExceptionNamespaceType:
- description: >
- Determines whether the exception container is available in all Kibana
- spaces or just the space
-
+ description: |
+ Determines whether the exception container is available in all Kibana spaces or just the space
in which it is created, where:
-
- `single`: Only available in the Kibana space in which it is created.
-
- `agnostic`: Available in all Kibana spaces.
enum:
- agnostic
@@ -47633,8 +46524,7 @@ components:
- comment
Security_Exceptions_API_UpdateExceptionListItemCommentArray:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_UpdateExceptionListItemComment
+ $ref: '#/components/schemas/Security_Exceptions_API_UpdateExceptionListItemComment'
type: array
Security_Exceptions_API_UUID:
description: A universally unique identifier
@@ -48326,9 +47216,7 @@ components:
$ref: '#/components/schemas/Security_Timeline_API_DataProviderType'
nullable: true
Security_Timeline_API_DataProviderType:
- description: >-
- The type of data provider to create. Valid values are `default` and
- `template`.
+ description: The type of data provider to create. Valid values are `default` and `template`.
enum:
- default
- template
@@ -48522,8 +47410,7 @@ components:
oneOf:
- allOf:
- $ref: '#/components/schemas/Security_Timeline_API_PinnedEvent'
- - $ref: >-
- #/components/schemas/Security_Timeline_API_PinnedEventBaseResponseBody
+ - $ref: '#/components/schemas/Security_Timeline_API_PinnedEventBaseResponseBody'
- nullable: true
type: object
Security_Timeline_API_PersistTimelineResponse:
@@ -48591,15 +47478,13 @@ components:
type: object
properties:
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Timeline_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Timeline_API_SavedObjectResolveAliasPurpose'
alias_target_id:
type: string
outcome:
$ref: '#/components/schemas/Security_Timeline_API_SavedObjectResolveOutcome'
timeline:
- $ref: >-
- #/components/schemas/Security_Timeline_API_TimelineSavedToReturnObject
+ $ref: '#/components/schemas/Security_Timeline_API_TimelineSavedToReturnObject'
required:
- timeline
- outcome
@@ -48744,8 +47629,7 @@ components:
nullable: true
type: string
kqlQuery:
- $ref: >-
- #/components/schemas/Security_Timeline_API_SerializedFilterQueryResult
+ $ref: '#/components/schemas/Security_Timeline_API_SerializedFilterQueryResult'
nullable: true
savedQueryId:
nullable: true
@@ -48842,8 +47726,7 @@ components:
Security_Timeline_API_TimelineResponse:
allOf:
- $ref: '#/components/schemas/Security_Timeline_API_SavedTimeline'
- - $ref: >-
- #/components/schemas/Security_Timeline_API_SavedTimelineWithSavedObjectId
+ - $ref: '#/components/schemas/Security_Timeline_API_SavedTimelineWithSavedObjectId'
- type: object
properties:
eventIdToNoteIds:
@@ -48909,18 +47792,14 @@ components:
- savedObjectId
- version
Security_Timeline_API_TimelineStatus:
- description: >-
- The status of the timeline. Valid values are `active`, `draft`, and
- `immutable`.
+ description: The status of the timeline. Valid values are `active`, `draft`, and `immutable`.
enum:
- active
- draft
- immutable
type: string
Security_Timeline_API_TimelineType:
- description: >-
- The type of timeline to create. Valid values are `default` and
- `template`.
+ description: The type of timeline to create. Valid values are `default` and `template`.
enum:
- default
- template
@@ -49037,9 +47916,8 @@ components:
title: Budgeting method
type: string
SLOs_create_slo_request:
- description: >
- The create SLO API request body varies depending on the type of
- indicator, time window and budgeting method.
+ description: |
+ The create SLO API request body varies depending on the type of indicator, time window and budgeting method.
properties:
budgetingMethod:
$ref: '#/components/schemas/SLOs_budgeting_method'
@@ -49049,9 +47927,7 @@ components:
groupBy:
$ref: '#/components/schemas/SLOs_group_by'
id:
- description: >-
- A optional and unique identifier for the SLO. Must be between 8 and
- 36 chars
+ description: A optional and unique identifier for the SLO. Must be between 8 and 36 chars
example: my-super-slo-id
type: string
indicator:
@@ -49095,10 +47971,8 @@ components:
required:
- id
SLOs_delete_slo_instances_request:
- description: >
- The delete SLO instances request takes a list of SLO id and instance id,
- then delete the rollup and summary data. This API can be used to remove
- the staled data of an instance SLO that no longer get updated.
+ description: |
+ The delete SLO instances request takes a list of SLO id and instance id, then delete the rollup and summary data. This API can be used to remove the staled data of an instance SLO that no longer get updated.
properties:
list:
description: An array of slo id and instance id
@@ -49134,9 +48008,7 @@ components:
example: 0.02
type: number
isEstimated:
- description: >-
- Only for SLO defined with occurrences budgeting method and calendar
- aligned time window.
+ description: Only for SLO defined with occurrences budgeting method and calendar aligned time window.
example: true
type: boolean
remaining:
@@ -49207,9 +48079,7 @@ components:
title: Find SLO response
type: object
SLOs_group_by:
- description: >-
- optional group by field or fields to use to generate an SLO per distinct
- value
+ description: optional group by field or fields to use to generate an SLO per distinct value
example:
- - service.name
- service.name
@@ -49330,11 +48200,7 @@ components:
type: object
properties:
dataViewId:
- description: >-
- The kibana data view id to use, primarily used to include data
- view runtime mappings. Make sure to save SLO again if you
- add/update run time fields to the data view and if those fields
- are being used in slo queries.
+ description: The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
example: 03b80ab3-003d-498b-881c-3beedbaf1162
type: string
filter:
@@ -49375,11 +48241,7 @@ components:
type: object
properties:
dataViewId:
- description: >-
- The kibana data view id to use, primarily used to include data
- view runtime mappings. Make sure to save SLO again if you
- add/update run time fields to the data view and if those fields
- are being used in slo queries.
+ description: The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
example: 03b80ab3-003d-498b-881c-3beedbaf1162
type: string
filter:
@@ -49396,16 +48258,12 @@ components:
example: A
type: string
metrics:
- description: >-
- List of metrics with their name, aggregation type, and
- field.
+ description: List of metrics with their name, aggregation type, and field.
items:
type: object
properties:
aggregation:
- description: >-
- The aggregation type of the metric. Only valid option
- is "sum"
+ description: The aggregation type of the metric. Only valid option is "sum"
enum:
- sum
example: sum
@@ -49450,16 +48308,12 @@ components:
example: A
type: string
metrics:
- description: >-
- List of metrics with their name, aggregation type, and
- field.
+ description: List of metrics with their name, aggregation type, and field.
items:
type: object
properties:
aggregation:
- description: >-
- The aggregation type of the metric. Only valid option
- is "sum"
+ description: The aggregation type of the metric. Only valid option is "sum"
enum:
- sum
example: sum
@@ -49508,11 +48362,7 @@ components:
type: object
properties:
dataViewId:
- description: >-
- The kibana data view id to use, primarily used to include data
- view runtime mappings. Make sure to save SLO again if you
- add/update run time fields to the data view and if those fields
- are being used in slo queries.
+ description: The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
example: 03b80ab3-003d-498b-881c-3beedbaf1162
type: string
filter:
@@ -49540,15 +48390,11 @@ components:
example: 'processor.outcome: "success"'
type: string
from:
- description: >-
- The starting value of the range. Only required for "range"
- aggregations.
+ description: The starting value of the range. Only required for "range" aggregations.
example: 0
type: number
to:
- description: >-
- The ending value of the range. Only required for "range"
- aggregations.
+ description: The ending value of the range. Only required for "range" aggregations.
example: 100
type: number
required:
@@ -49584,15 +48430,11 @@ components:
example: 'processor.outcome : *'
type: string
from:
- description: >-
- The starting value of the range. Only required for "range"
- aggregations.
+ description: The starting value of the range. Only required for "range" aggregations.
example: 0
type: number
to:
- description: >-
- The ending value of the range. Only required for "range"
- aggregations.
+ description: The ending value of the range. Only required for "range" aggregations.
example: 100
type: number
required:
@@ -49621,11 +48463,7 @@ components:
type: object
properties:
dataViewId:
- description: >-
- The kibana data view id to use, primarily used to include data
- view runtime mappings. Make sure to save SLO again if you
- add/update run time fields to the data view and if those fields
- are being used in slo queries.
+ description: The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
example: 03b80ab3-003d-498b-881c-3beedbaf1162
type: string
filter:
@@ -49637,15 +48475,12 @@ components:
example: my-service-*
type: string
metric:
- description: >
- An object defining the metrics, equation, and threshold to
- determine if it's a good slice or not
+ description: |
+ An object defining the metrics, equation, and threshold to determine if it's a good slice or not
type: object
properties:
comparator:
- description: >-
- The comparator to use to compare the equation to the
- threshold.
+ description: The comparator to use to compare the equation to the threshold.
enum:
- GT
- GTE
@@ -49658,22 +48493,15 @@ components:
example: A
type: string
metrics:
- description: >-
- List of metrics with their name, aggregation type, and
- field.
+ description: List of metrics with their name, aggregation type, and field.
items:
anyOf:
- - $ref: >-
- #/components/schemas/SLOs_timeslice_metric_basic_metric_with_field
- - $ref: >-
- #/components/schemas/SLOs_timeslice_metric_percentile_metric
- - $ref: >-
- #/components/schemas/SLOs_timeslice_metric_doc_count_metric
+ - $ref: '#/components/schemas/SLOs_timeslice_metric_basic_metric_with_field'
+ - $ref: '#/components/schemas/SLOs_timeslice_metric_percentile_metric'
+ - $ref: '#/components/schemas/SLOs_timeslice_metric_doc_count_metric'
type: array
threshold:
- description: >-
- The threshold used to determine if the metric is a good
- slice or not.
+ description: The threshold used to determine if the metric is a good slice or not.
example: 100
type: number
required:
@@ -49756,17 +48584,13 @@ components:
minimum: 0
type: number
timesliceTarget:
- description: >-
- the target objective for each slice when using a timeslices
- budgeting method
+ description: the target objective for each slice when using a timeslices budgeting method
example: 0.995
maximum: 100
minimum: 0
type: number
timesliceWindow:
- description: >-
- the duration of each slice when using a timeslices budgeting method,
- as {duraton}{unit}
+ description: the duration of each slice when using a timeslices budgeting method, as {duraton}{unit}
example: 5m
type: string
required:
@@ -49998,16 +48822,11 @@ components:
type: object
properties:
duration:
- description: >-
- the duration formatted as {duration}{unit}. Accepted values for
- rolling: 7d, 30d, 90d. Accepted values for calendar aligned: 1w
- (weekly) or 1M (monthly)
+ description: 'the duration formatted as {duration}{unit}. Accepted values for rolling: 7d, 30d, 90d. Accepted values for calendar aligned: 1w (weekly) or 1M (monthly)'
example: 30d
type: string
type:
- description: >-
- Indicates weither the time window is a rolling or a calendar aligned
- time window.
+ description: Indicates weither the time window is a rolling or a calendar aligned time window.
enum:
- rolling
- calendarAligned
@@ -50076,9 +48895,7 @@ components:
type: object
properties:
aggregation:
- description: >-
- The aggregation type of the metric. Only valid option is
- "percentile"
+ description: The aggregation type of the metric. Only valid option is "percentile"
enum:
- percentile
example: percentile
@@ -50107,9 +48924,8 @@ components:
- percentile
title: Timeslice Metric Percentile Metric
SLOs_update_slo_request:
- description: >
- The update SLO API request body varies depending on the type of
- indicator, time window and budgeting method. Partial update is handled.
+ description: |
+ The update SLO API request body varies depending on the type of indicator, time window and budgeting method. Partial update is handled.
properties:
budgetingMethod:
$ref: '#/components/schemas/SLOs_budgeting_method'
@@ -50142,117 +48958,2846 @@ components:
$ref: '#/components/schemas/SLOs_time_window'
title: Update SLO request
type: object
- securitySchemes:
- apiKeyAuth:
- description: >-
- You must create an API key and use the encoded value in the request
- header. To learn about creating keys, go to [API
- keys](https://www.elastic.co/docs/current/serverless/api-keys).
- in: header
- name: Authorization
- type: apiKey
-security:
- - apiKeyAuth: []
-tags:
- - name: alerting
- - description: |
- Adjust APM agent configuration without need to redeploy your application.
- name: APM agent configuration
- - description: >
- Configure APM agent keys to authorize requests from APM agents to the APM
- Server.
- name: APM agent keys
- - description: >
- Annotate visualizations in the APM app with significant events.
- Annotations enable you to easily see how events are impacting the
- performance of your applications.
- name: APM annotations
- - description: Create APM fleet server schema.
- name: APM server schema
- - description: Configure APM source maps.
- name: APM sourcemaps
- - name: connectors
- - name: Data streams
- - description: >-
- Data view APIs enable you to manage data views, formerly known as Kibana
- index patterns.
- name: data views
- - name: Elastic Agent actions
- - name: Elastic Agent binary download sources
- - name: Elastic Agent policies
- - name: Elastic Agent status
- - name: Elastic Agents
- - name: Elastic Package Manager (EPM)
- - name: Fleet enrollment API keys
- - name: Fleet internals
- - name: Fleet outputs
- - name: Fleet package policies
- - name: Fleet proxies
- - name: Fleet Server hosts
- - name: Fleet service tokens
- - name: Fleet uninstall tokens
- - name: Message Signing Service
- - description: Machine learning
- name: ml
- - name: roles
- - description: >
- Export sets of saved objects that you want to import into Kibana, resolve
- import errors, and rotate an encryption key for encrypted saved objects
- with the saved objects APIs.
-
-
- To manage a specific type of saved object, use the corresponding APIs.
-
- For example, use:
-
-
- [Data views](../group/endpoint-data-views)
-
-
- Warning: Do not write documents directly to the `.kibana` index. When you
- write directly to the `.kibana` index, the data becomes corrupted and
- permanently breaks future Kibana versions.
- name: saved objects
- x-displayName: Saved objects
- - description: Manage and interact with Security Assistant resources.
- name: Security AI Assistant API
- x-displayName: Security AI assistant
- - description: >-
- You can create rules that automatically turn events and external alerts
- sent to Elastic Security into detection alerts. These alerts are displayed
- on the Detections page.
- name: Security Detections API
- x-displayName: Security detections
- - description: >-
- Endpoint Exceptions API allows you to manage detection rule endpoint
- exceptions to prevent a rule from generating an alert from incoming events
- even when the rule's other criteria are met.
- name: Security Endpoint Exceptions API
- x-displayName: Security endpoint exceptions
- - description: Interact with and manage endpoints running the Elastic Defend integration.
- name: Security Endpoint Management API
- x-displayName: Security endpoint management
- - description: ''
- name: Security Entity Analytics API
- x-displayName: Security entity analytics
- - description: >-
- Exceptions API allows you to manage detection rule exceptions to prevent a
- rule from generating an alert from incoming events even when the rule's
- other criteria are met.
- name: Security Exceptions API
- x-displayName: Security exceptions
- - description: Lists API allows you to manage lists of keywords, IPs or IP ranges items.
- name: Security Lists API
- x-displayName: Security lists
- - description: Run live queries, manage packs and saved queries.
- name: Security Osquery API
- x-displayName: Security Osquery
- - description: >-
- You can create Timelines and Timeline templates via the API, as well as
- import new Timelines from an ndjson file.
- name: Security Timeline API
- x-displayName: Security timeline
- - description: SLO APIs enable you to define, manage and track service-level objectives
- name: slo
- - name: spaces
- - name: system
+ bedrock_config:
+ title: Connector request properties for an Amazon Bedrock connector
+ description: Defines properties for connectors when type is `.bedrock`.
+ type: object
+ required:
+ - apiUrl
+ properties:
+ apiUrl:
+ type: string
+ description: The Amazon Bedrock request URL.
+ defaultModel:
+ type: string
+ description: |
+ The generative artificial intelligence model for Amazon Bedrock to use. Current support is for the Anthropic Claude models.
+ default: anthropic.claude-3-5-sonnet-20240620-v1:0
+ crowdstrike_config:
+ title: Connector request config properties for a Crowdstrike connector
+ required:
+ - url
+ description: Defines config properties for connectors when type is `.crowdstrike`.
+ type: object
+ properties:
+ url:
+ description: |
+ The CrowdStrike tenant URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ type: string
+ d3security_config:
+ title: Connector request properties for a D3 Security connector
+ description: Defines properties for connectors when type is `.d3security`.
+ type: object
+ required:
+ - url
+ properties:
+ url:
+ type: string
+ description: |
+ The D3 Security API request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ email_config:
+ title: Connector request properties for an email connector
+ description: Defines properties for connectors when type is `.email`.
+ required:
+ - from
+ type: object
+ properties:
+ clientId:
+ description: |
+ The client identifier, which is a part of OAuth 2.0 client credentials authentication, in GUID format. If `service` is `exchange_server`, this property is required.
+ type: string
+ nullable: true
+ from:
+ description: |
+ The from address for all emails sent by the connector. It must be specified in `user@host-name` format.
+ type: string
+ hasAuth:
+ description: |
+ Specifies whether a user and password are required inside the secrets configuration.
+ default: true
+ type: boolean
+ host:
+ description: |
+ The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.
+ type: string
+ oauthTokenUrl:
+ type: string
+ nullable: true
+ port:
+ description: |
+ The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.
+ type: integer
+ secure:
+ description: |
+ Specifies whether the connection to the service provider will use TLS. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored.
+ type: boolean
+ service:
+ description: |
+ The name of the email service.
+ type: string
+ enum:
+ - elastic_cloud
+ - exchange_server
+ - gmail
+ - other
+ - outlook365
+ - ses
+ tenantId:
+ description: |
+ The tenant identifier, which is part of OAuth 2.0 client credentials authentication, in GUID format. If `service` is `exchange_server`, this property is required.
+ type: string
+ nullable: true
+ gemini_config:
+ title: Connector request properties for an Google Gemini connector
+ description: Defines properties for connectors when type is `.gemini`.
+ type: object
+ required:
+ - apiUrl
+ - gcpRegion
+ - gcpProjectID
+ properties:
+ apiUrl:
+ type: string
+ description: The Google Gemini request URL.
+ defaultModel:
+ type: string
+ description: The generative artificial intelligence model for Google Gemini to use.
+ default: gemini-1.5-pro-002
+ gcpRegion:
+ type: string
+ description: The GCP region where the Vertex AI endpoint enabled.
+ gcpProjectID:
+ type: string
+ description: The Google ProjectID that has Vertex AI endpoint enabled.
+ resilient_config:
+ title: Connector request properties for a IBM Resilient connector
+ required:
+ - apiUrl
+ - orgId
+ description: Defines properties for connectors when type is `.resilient`.
+ type: object
+ properties:
+ apiUrl:
+ description: The IBM Resilient instance URL.
+ type: string
+ orgId:
+ description: The IBM Resilient organization ID.
+ type: string
+ index_config:
+ title: Connector request properties for an index connector
+ required:
+ - index
+ description: Defines properties for connectors when type is `.index`.
+ type: object
+ properties:
+ executionTimeField:
+ description: A field that indicates when the document was indexed.
+ default: null
+ type: string
+ nullable: true
+ index:
+ description: The Elasticsearch index to be written to.
+ type: string
+ refresh:
+ description: |
+ The refresh policy for the write request, which affects when changes are made visible to search. Refer to the refresh setting for Elasticsearch document APIs.
+ default: false
+ type: boolean
+ jira_config:
+ title: Connector request properties for a Jira connector
+ required:
+ - apiUrl
+ - projectKey
+ description: Defines properties for connectors when type is `.jira`.
+ type: object
+ properties:
+ apiUrl:
+ description: The Jira instance URL.
+ type: string
+ projectKey:
+ description: The Jira project key.
+ type: string
+ genai_azure_config:
+ title: Connector request properties for an OpenAI connector that uses Azure OpenAI
+ description: |
+ Defines properties for connectors when type is `.gen-ai` and the API provider is `Azure OpenAI`.
+ type: object
+ required:
+ - apiProvider
+ - apiUrl
+ properties:
+ apiProvider:
+ type: string
+ description: The OpenAI API provider.
+ enum:
+ - Azure OpenAI
+ apiUrl:
+ type: string
+ description: The OpenAI API endpoint.
+ genai_openai_config:
+ title: Connector request properties for an OpenAI connector
+ description: |
+ Defines properties for connectors when type is `.gen-ai` and the API provider is `OpenAI`.
+ type: object
+ required:
+ - apiProvider
+ - apiUrl
+ properties:
+ apiProvider:
+ type: string
+ description: The OpenAI API provider.
+ enum:
+ - OpenAI
+ apiUrl:
+ type: string
+ description: The OpenAI API endpoint.
+ defaultModel:
+ type: string
+ description: The default model to use for requests.
+ opsgenie_config:
+ title: Connector request properties for an Opsgenie connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.opsgenie`.
+ type: object
+ properties:
+ apiUrl:
+ description: |
+ The Opsgenie URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ type: string
+ pagerduty_config:
+ title: Connector request properties for a PagerDuty connector
+ description: Defines properties for connectors when type is `.pagerduty`.
+ type: object
+ properties:
+ apiUrl:
+ description: The PagerDuty event URL.
+ type: string
+ nullable: true
+ example: https://events.pagerduty.com/v2/enqueue
+ sentinelone_config:
+ title: Connector request properties for a SentinelOne connector
+ required:
+ - url
+ description: Defines properties for connectors when type is `.sentinelone`.
+ type: object
+ properties:
+ url:
+ description: |
+ The SentinelOne tenant URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ type: string
+ servicenow_config:
+ title: Connector request properties for a ServiceNow ITSM connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.servicenow`.
+ type: object
+ properties:
+ apiUrl:
+ type: string
+ description: The ServiceNow instance URL.
+ clientId:
+ description: |
+ The client ID assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ isOAuth:
+ description: |
+ The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).
+ default: false
+ type: boolean
+ jwtKeyId:
+ description: |
+ The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ userIdentifierValue:
+ description: |
+ The identifier to use for OAuth authentication. This identifier should be the user field you selected when you created an OAuth JWT API endpoint for external clients in your ServiceNow instance. For example, if the selected user field is `Email`, the user identifier should be the user's email address. This property is required when `isOAuth` is `true`.
+ type: string
+ usesTableApi:
+ description: |
+ Determines whether the connector uses the Table API or the Import Set API. This property is supported only for ServiceNow ITSM and ServiceNow SecOps connectors. NOTE: If this property is set to `false`, the Elastic application should be installed in ServiceNow.
+ default: true
+ type: boolean
+ servicenow_itom_config:
+ title: Connector request properties for a ServiceNow ITOM connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.servicenow-itom`.
+ type: object
+ properties:
+ apiUrl:
+ type: string
+ description: The ServiceNow instance URL.
+ clientId:
+ description: |
+ The client ID assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ isOAuth:
+ description: |
+ The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).
+ default: false
+ type: boolean
+ jwtKeyId:
+ description: |
+ The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ userIdentifierValue:
+ description: |
+ The identifier to use for OAuth authentication. This identifier should be the user field you selected when you created an OAuth JWT API endpoint for external clients in your ServiceNow instance. For example, if the selected user field is `Email`, the user identifier should be the user's email address. This property is required when `isOAuth` is `true`.
+ type: string
+ slack_api_config:
+ title: Connector request properties for a Slack connector
+ description: Defines properties for connectors when type is `.slack_api`.
+ type: object
+ properties:
+ allowedChannels:
+ type: array
+ description: A list of valid Slack channels.
+ items:
+ type: object
+ required:
+ - id
+ - name
+ maxItems: 25
+ properties:
+ id:
+ type: string
+ description: The Slack channel ID.
+ example: C123ABC456
+ minLength: 1
+ name:
+ type: string
+ description: The Slack channel name.
+ minLength: 1
+ swimlane_config:
+ title: Connector request properties for a Swimlane connector
+ required:
+ - apiUrl
+ - appId
+ - connectorType
+ description: Defines properties for connectors when type is `.swimlane`.
+ type: object
+ properties:
+ apiUrl:
+ description: The Swimlane instance URL.
+ type: string
+ appId:
+ description: The Swimlane application ID.
+ type: string
+ connectorType:
+ description: The type of connector. Valid values are `all`, `alerts`, and `cases`.
+ type: string
+ enum:
+ - all
+ - alerts
+ - cases
+ mappings:
+ title: Connector mappings properties for a Swimlane connector
+ description: The field mapping.
+ type: object
+ properties:
+ alertIdConfig:
+ title: Alert identifier mapping
+ description: Mapping for the alert ID.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ caseIdConfig:
+ title: Case identifier mapping
+ description: Mapping for the case ID.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ caseNameConfig:
+ title: Case name mapping
+ description: Mapping for the case name.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ commentsConfig:
+ title: Case comment mapping
+ description: Mapping for the case comments.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ descriptionConfig:
+ title: Case description mapping
+ description: Mapping for the case description.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ ruleNameConfig:
+ title: Rule name mapping
+ description: Mapping for the name of the alert's rule.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ severityConfig:
+ title: Severity mapping
+ description: Mapping for the severity.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ thehive_config:
+ title: Connector request properties for a TheHive connector
+ description: Defines configuration properties for connectors when type is `.thehive`.
+ type: object
+ required:
+ - url
+ properties:
+ organisation:
+ type: string
+ description: |
+ The organisation in TheHive that will contain the alerts or cases. By default, the connector uses the default organisation of the user account that created the API key.
+ url:
+ type: string
+ description: |
+ The instance URL in TheHive. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ tines_config:
+ title: Connector request properties for a Tines connector
+ description: Defines properties for connectors when type is `.tines`.
+ type: object
+ required:
+ - url
+ properties:
+ url:
+ description: |
+ The Tines tenant URL. If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.
+ type: string
+ torq_config:
+ title: Connector request properties for a Torq connector
+ description: Defines properties for connectors when type is `.torq`.
+ type: object
+ required:
+ - webhookIntegrationUrl
+ properties:
+ webhookIntegrationUrl:
+ description: The endpoint URL of the Elastic Security integration in Torq.
+ type: string
+ auth_type:
+ title: Authentication type
+ type: string
+ nullable: true
+ enum:
+ - webhook-authentication-basic
+ - webhook-authentication-ssl
+ description: |
+ The type of authentication to use: basic, SSL, or none.
+ ca:
+ title: Certificate authority
+ type: string
+ description: |
+ A base64 encoded version of the certificate authority file that the connector can trust to sign and validate certificates. This option is available for all authentication types.
+ cert_type:
+ title: Certificate type
+ type: string
+ description: |
+ If the `authType` is `webhook-authentication-ssl`, specifies whether the certificate authentication data is in a CRT and key file format or a PFX file format.
+ enum:
+ - ssl-crt-key
+ - ssl-pfx
+ has_auth:
+ title: Has authentication
+ type: boolean
+ description: If true, a username and password for login type authentication must be provided.
+ default: true
+ verification_mode:
+ title: Verification mode
+ type: string
+ enum:
+ - certificate
+ - full
+ - none
+ default: full
+ description: |
+ Controls the verification of certificates. Use `full` to validate that the certificate has an issue date within the `not_before` and `not_after` dates, chains to a trusted certificate authority (CA), and has a hostname or IP address that matches the names within the certificate. Use `certificate` to validate the certificate and verify that it is signed by a trusted authority; this option does not check the certificate hostname. Use `none` to skip certificate validation.
+ webhook_config:
+ title: Connector request properties for a Webhook connector
+ description: Defines properties for connectors when type is `.webhook`.
+ type: object
+ properties:
+ authType:
+ $ref: '#/components/schemas/auth_type'
+ ca:
+ $ref: '#/components/schemas/ca'
+ certType:
+ $ref: '#/components/schemas/cert_type'
+ hasAuth:
+ $ref: '#/components/schemas/has_auth'
+ headers:
+ type: object
+ nullable: true
+ description: A set of key-value pairs sent as headers with the request.
+ method:
+ type: string
+ default: post
+ enum:
+ - post
+ - put
+ description: |
+ The HTTP request method, either `post` or `put`.
+ url:
+ type: string
+ description: |
+ The request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ verificationMode:
+ $ref: '#/components/schemas/verification_mode'
+ cases_webhook_config:
+ title: Connector request properties for Webhook - Case Management connector
+ required:
+ - createIncidentJson
+ - createIncidentResponseKey
+ - createIncidentUrl
+ - getIncidentResponseExternalTitleKey
+ - getIncidentUrl
+ - updateIncidentJson
+ - updateIncidentUrl
+ - viewIncidentUrl
+ description: Defines properties for connectors when type is `.cases-webhook`.
+ type: object
+ properties:
+ authType:
+ $ref: '#/components/schemas/auth_type'
+ ca:
+ $ref: '#/components/schemas/ca'
+ certType:
+ $ref: '#/components/schemas/cert_type'
+ createCommentJson:
+ type: string
+ description: |
+ A JSON payload sent to the create comment URL to create a case comment. You can use variables to add Kibana Cases data to the payload. The required variable is `case.comment`. Due to Mustache template variables (the text enclosed in triple braces, for example, `{{{case.title}}}`), the JSON is not validated when you create the connector. The JSON is validated once the Mustache variables have been placed when the REST method runs. Manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass.
+ example: '{"body": {{{case.comment}}}}'
+ createCommentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to create a case comment in the third-party system. Valid values are `patch`, `post`, and `put`.
+ default: put
+ enum:
+ - patch
+ - post
+ - put
+ createCommentUrl:
+ type: string
+ description: |
+ The REST API URL to create a case comment by ID in the third-party system. You can use a variable to add the external system ID to the URL. If you are using the `xpack.actions.allowedHosts setting`, add the hostname to the allowed hosts.
+ example: https://example.com/issue/{{{external.system.id}}}/comment
+ createIncidentJson:
+ type: string
+ description: |
+ A JSON payload sent to the create case URL to create a case. You can use variables to add case data to the payload. Required variables are `case.title` and `case.description`. Due to Mustache template variables (which is the text enclosed in triple braces, for example, `{{{case.title}}}`), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid to avoid future validation errors; disregard Mustache variables during your review.
+ example: '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
+ createIncidentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to create a case in the third-party system. Valid values are `patch`, `post`, and `put`.
+ enum:
+ - patch
+ - post
+ - put
+ default: post
+ createIncidentResponseKey:
+ type: string
+ description: The JSON key in the create external case response that contains the case ID.
+ createIncidentUrl:
+ type: string
+ description: |
+ The REST API URL to create a case in the third-party system. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ getIncidentResponseExternalTitleKey:
+ type: string
+ description: The JSON key in get external case response that contains the case title.
+ getIncidentUrl:
+ type: string
+ description: |
+ The REST API URL to get the case by ID from the third-party system. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts. You can use a variable to add the external system ID to the URL. Due to Mustache template variables (the text enclosed in triple braces, for example, `{{{case.title}}}`), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass.
+ example: https://example.com/issue/{{{external.system.id}}}
+ hasAuth:
+ $ref: '#/components/schemas/has_auth'
+ headers:
+ type: string
+ description: |
+ A set of key-value pairs sent as headers with the request URLs for the create case, update case, get case, and create comment methods.
+ updateIncidentJson:
+ type: string
+ description: |
+ The JSON payload sent to the update case URL to update the case. You can use variables to add Kibana Cases data to the payload. Required variables are `case.title` and `case.description`. Due to Mustache template variables (which is the text enclosed in triple braces, for example, `{{{case.title}}}`), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid to avoid future validation errors; disregard Mustache variables during your review.
+ example: '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
+ updateIncidentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to update the case in the third-party system. Valid values are `patch`, `post`, and `put`.
+ default: put
+ enum:
+ - patch
+ - post
+ - put
+ updateIncidentUrl:
+ type: string
+ description: |
+ The REST API URL to update the case by ID in the third-party system. You can use a variable to add the external system ID to the URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ example: https://example.com/issue/{{{external.system.ID}}}
+ verificationMode:
+ $ref: '#/components/schemas/verification_mode'
+ viewIncidentUrl:
+ type: string
+ description: |
+ The URL to view the case in the external system. You can use variables to add the external system ID or external system title to the URL.
+ example: https://testing-jira.atlassian.net/browse/{{{external.system.title}}}
+ xmatters_config:
+ title: Connector request properties for an xMatters connector
+ description: Defines properties for connectors when type is `.xmatters`.
+ type: object
+ properties:
+ configUrl:
+ description: |
+ The request URL for the Elastic Alerts trigger in xMatters. It is applicable only when `usesBasic` is `true`.
+ type: string
+ nullable: true
+ usesBasic:
+ description: Specifies whether the connector uses HTTP basic authentication (`true`) or URL authentication (`false`).
+ type: boolean
+ default: true
+ bedrock_secrets:
+ title: Connector secrets properties for an Amazon Bedrock connector
+ description: Defines secrets for connectors when type is `.bedrock`.
+ type: object
+ required:
+ - accessKey
+ - secret
+ properties:
+ accessKey:
+ type: string
+ description: The AWS access key for authentication.
+ secret:
+ type: string
+ description: The AWS secret for authentication.
+ crowdstrike_secrets:
+ title: Connector secrets properties for a Crowdstrike connector
+ description: Defines secrets for connectors when type is `.crowdstrike`.
+ type: object
+ required:
+ - clientId
+ - clientSecret
+ properties:
+ clientId:
+ description: The CrowdStrike API client identifier.
+ type: string
+ clientSecret:
+ description: The CrowdStrike API client secret to authenticate the `clientId`.
+ type: string
+ d3security_secrets:
+ title: Connector secrets properties for a D3 Security connector
+ description: Defines secrets for connectors when type is `.d3security`.
+ required:
+ - token
+ type: object
+ properties:
+ token:
+ type: string
+ description: The D3 Security token.
+ email_secrets:
+ title: Connector secrets properties for an email connector
+ description: Defines secrets for connectors when type is `.email`.
+ type: object
+ properties:
+ clientSecret:
+ type: string
+ description: |
+ The Microsoft Exchange Client secret for OAuth 2.0 client credentials authentication. It must be URL-encoded. If `service` is `exchange_server`, this property is required.
+ password:
+ type: string
+ description: |
+ The password for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
+ user:
+ type: string
+ description: |
+ The username for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
+ gemini_secrets:
+ title: Connector secrets properties for a Google Gemini connector
+ description: Defines secrets for connectors when type is `.gemini`.
+ type: object
+ required:
+ - credentialsJson
+ properties:
+ credentialsJson:
+ type: string
+ description: The service account credentials JSON file. The service account should have Vertex AI user IAM role assigned to it.
+ resilient_secrets:
+ title: Connector secrets properties for IBM Resilient connector
+ required:
+ - apiKeyId
+ - apiKeySecret
+ description: Defines secrets for connectors when type is `.resilient`.
+ type: object
+ properties:
+ apiKeyId:
+ type: string
+ description: The authentication key ID for HTTP Basic authentication.
+ apiKeySecret:
+ type: string
+ description: The authentication key secret for HTTP Basic authentication.
+ jira_secrets:
+ title: Connector secrets properties for a Jira connector
+ required:
+ - apiToken
+ - email
+ description: Defines secrets for connectors when type is `.jira`.
+ type: object
+ properties:
+ apiToken:
+ description: The Jira API authentication token for HTTP basic authentication.
+ type: string
+ email:
+ description: The account email for HTTP Basic authentication.
+ type: string
+ teams_secrets:
+ title: Connector secrets properties for a Microsoft Teams connector
+ description: Defines secrets for connectors when type is `.teams`.
+ type: object
+ required:
+ - webhookUrl
+ properties:
+ webhookUrl:
+ type: string
+ description: |
+ The URL of the incoming webhook. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ genai_secrets:
+ title: Connector secrets properties for an OpenAI connector
+ description: Defines secrets for connectors when type is `.gen-ai`.
+ type: object
+ properties:
+ apiKey:
+ type: string
+ description: The OpenAI API key.
+ opsgenie_secrets:
+ title: Connector secrets properties for an Opsgenie connector
+ required:
+ - apiKey
+ description: Defines secrets for connectors when type is `.opsgenie`.
+ type: object
+ properties:
+ apiKey:
+ description: The Opsgenie API authentication key for HTTP Basic authentication.
+ type: string
+ pagerduty_secrets:
+ title: Connector secrets properties for a PagerDuty connector
+ description: Defines secrets for connectors when type is `.pagerduty`.
+ type: object
+ required:
+ - routingKey
+ properties:
+ routingKey:
+ description: |
+ A 32 character PagerDuty Integration Key for an integration on a service.
+ type: string
+ sentinelone_secrets:
+ title: Connector secrets properties for a SentinelOne connector
+ description: Defines secrets for connectors when type is `.sentinelone`.
+ type: object
+ required:
+ - token
+ properties:
+ token:
+ description: The A SentinelOne API token.
+ type: string
+ servicenow_secrets:
+ title: Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors
+ description: Defines secrets for connectors when type is `.servicenow`, `.servicenow-sir`, or `.servicenow-itom`.
+ type: object
+ properties:
+ clientSecret:
+ type: string
+ description: The client secret assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ password:
+ type: string
+ description: The password for HTTP basic authentication. This property is required when `isOAuth` is `false`.
+ privateKey:
+ type: string
+ description: The RSA private key that you created for use in ServiceNow. This property is required when `isOAuth` is `true`.
+ privateKeyPassword:
+ type: string
+ description: The password for the RSA private key. This property is required when `isOAuth` is `true` and you set a password on your private key.
+ username:
+ type: string
+ description: The username for HTTP basic authentication. This property is required when `isOAuth` is `false`.
+ slack_api_secrets:
+ title: Connector secrets properties for a Web API Slack connector
+ description: Defines secrets for connectors when type is `.slack`.
+ required:
+ - token
+ type: object
+ properties:
+ token:
+ type: string
+ description: Slack bot user OAuth token.
+ swimlane_secrets:
+ title: Connector secrets properties for a Swimlane connector
+ description: Defines secrets for connectors when type is `.swimlane`.
+ type: object
+ properties:
+ apiToken:
+ description: Swimlane API authentication token.
+ type: string
+ thehive_secrets:
+ title: Connector secrets properties for a TheHive connector
+ description: Defines secrets for connectors when type is `.thehive`.
+ required:
+ - apiKey
+ type: object
+ properties:
+ apiKey:
+ type: string
+ description: The API key for authentication in TheHive.
+ tines_secrets:
+ title: Connector secrets properties for a Tines connector
+ description: Defines secrets for connectors when type is `.tines`.
+ type: object
+ required:
+ - email
+ - token
+ properties:
+ email:
+ description: The email used to sign in to Tines.
+ type: string
+ token:
+ description: The Tines API token.
+ type: string
+ torq_secrets:
+ title: Connector secrets properties for a Torq connector
+ description: Defines secrets for connectors when type is `.torq`.
+ type: object
+ required:
+ - token
+ properties:
+ token:
+ description: The secret of the webhook authentication header.
+ type: string
+ crt:
+ title: Certificate
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-crt-key`, it is a base64 encoded version of the CRT or CERT file.
+ key:
+ title: Certificate key
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-crt-key`, it is a base64 encoded version of the KEY file.
+ pfx:
+ title: Personal information exchange
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-pfx`, it is a base64 encoded version of the PFX or P12 file.
+ webhook_secrets:
+ title: Connector secrets properties for a Webhook connector
+ description: Defines secrets for connectors when type is `.webhook`.
+ type: object
+ properties:
+ crt:
+ $ref: '#/components/schemas/crt'
+ key:
+ $ref: '#/components/schemas/key'
+ pfx:
+ $ref: '#/components/schemas/pfx'
+ password:
+ type: string
+ description: |
+ The password for HTTP basic authentication or the passphrase for the SSL certificate files. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.
+ user:
+ type: string
+ description: |
+ The username for HTTP basic authentication. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.
+ cases_webhook_secrets:
+ title: Connector secrets properties for Webhook - Case Management connector
+ type: object
+ properties:
+ crt:
+ $ref: '#/components/schemas/crt'
+ key:
+ $ref: '#/components/schemas/key'
+ pfx:
+ $ref: '#/components/schemas/pfx'
+ password:
+ type: string
+ description: |
+ The password for HTTP basic authentication. If `hasAuth` is set to `true` and and `authType` is `webhook-authentication-basic`, this property is required.
+ user:
+ type: string
+ description: |
+ The username for HTTP basic authentication. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.
+ xmatters_secrets:
+ title: Connector secrets properties for an xMatters connector
+ description: Defines secrets for connectors when type is `.xmatters`.
+ type: object
+ properties:
+ password:
+ description: |
+ A user name for HTTP basic authentication. It is applicable only when `usesBasic` is `true`.
+ type: string
+ secretsUrl:
+ description: |
+ The request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL. It is applicable only when `usesBasic` is `false`.
+ type: string
+ user:
+ description: |
+ A password for HTTP basic authentication. It is applicable only when `usesBasic` is `true`.
+ type: string
+ run_acknowledge_resolve_pagerduty:
+ title: PagerDuty connector parameters
+ description: Test an action that acknowledges or resolves a PagerDuty alert.
+ type: object
+ required:
+ - dedupKey
+ - eventAction
+ properties:
+ dedupKey:
+ description: The deduplication key for the PagerDuty alert.
+ type: string
+ maxLength: 255
+ eventAction:
+ description: The type of event.
+ type: string
+ enum:
+ - acknowledge
+ - resolve
+ run_documents:
+ title: Index connector parameters
+ description: Test an action that indexes a document into Elasticsearch.
+ type: object
+ required:
+ - documents
+ properties:
+ documents:
+ type: array
+ description: The documents in JSON format for index connectors.
+ items:
+ type: object
+ additionalProperties: true
+ run_message_email:
+ title: Email connector parameters
+ description: |
+ Test an action that sends an email message. There must be at least one recipient in `to`, `cc`, or `bcc`.
+ type: object
+ required:
+ - message
+ - subject
+ - anyOf:
+ - to
+ - cc
+ - bcc
+ properties:
+ bcc:
+ type: array
+ items:
+ type: string
+ description: |
+ A list of "blind carbon copy" email addresses. Addresses can be specified in `user@host-name` format or in name `` format
+ cc:
+ type: array
+ items:
+ type: string
+ description: |
+ A list of "carbon copy" email addresses. Addresses can be specified in `user@host-name` format or in name `` format
+ message:
+ type: string
+ description: The email message text. Markdown format is supported.
+ subject:
+ type: string
+ description: The subject line of the email.
+ to:
+ type: array
+ description: |
+ A list of email addresses. Addresses can be specified in `user@host-name` format or in name `` format.
+ items:
+ type: string
+ run_message_serverlog:
+ title: Server log connector parameters
+ description: Test an action that writes an entry to the Kibana server log.
+ type: object
+ required:
+ - message
+ properties:
+ level:
+ type: string
+ description: The log level of the message for server log connectors.
+ enum:
+ - debug
+ - error
+ - fatal
+ - info
+ - trace
+ - warn
+ default: info
+ message:
+ type: string
+ description: The message for server log connectors.
+ run_message_slack:
+ title: Slack connector parameters
+ description: |
+ Test an action that sends a message to Slack. It is applicable only when the connector type is `.slack`.
+ type: object
+ required:
+ - message
+ properties:
+ message:
+ type: string
+ description: The Slack message text, which cannot contain Markdown, images, or other advanced formatting.
+ run_trigger_pagerduty:
+ title: PagerDuty connector parameters
+ description: Test an action that triggers a PagerDuty alert.
+ type: object
+ required:
+ - eventAction
+ properties:
+ class:
+ description: The class or type of the event.
+ type: string
+ example: cpu load
+ component:
+ description: The component of the source machine that is responsible for the event.
+ type: string
+ example: eth0
+ customDetails:
+ description: Additional details to add to the event.
+ type: object
+ dedupKey:
+ description: |
+ All actions sharing this key will be associated with the same PagerDuty alert. This value is used to correlate trigger and resolution.
+ type: string
+ maxLength: 255
+ eventAction:
+ description: The type of event.
+ type: string
+ enum:
+ - trigger
+ group:
+ description: The logical grouping of components of a service.
+ type: string
+ example: app-stack
+ links:
+ description: A list of links to add to the event.
+ type: array
+ items:
+ type: object
+ properties:
+ href:
+ description: The URL for the link.
+ type: string
+ text:
+ description: A plain text description of the purpose of the link.
+ type: string
+ severity:
+ description: The severity of the event on the affected system.
+ type: string
+ enum:
+ - critical
+ - error
+ - info
+ - warning
+ default: info
+ source:
+ description: |
+ The affected system, such as a hostname or fully qualified domain name. Defaults to the Kibana saved object id of the action.
+ type: string
+ summary:
+ description: A summery of the event.
+ type: string
+ maxLength: 1024
+ timestamp:
+ description: An ISO-8601 timestamp that indicates when the event was detected or generated.
+ type: string
+ format: date-time
+ run_addevent:
+ title: The addEvent subaction
+ type: object
+ required:
+ - subAction
+ description: The `addEvent` subaction for ServiceNow ITOM connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - addEvent
+ subActionParams:
+ type: object
+ description: The set of configuration properties for the action.
+ properties:
+ additional_info:
+ type: string
+ description: Additional information about the event.
+ description:
+ type: string
+ description: The details about the event.
+ event_class:
+ type: string
+ description: A specific instance of the source.
+ message_key:
+ type: string
+ description: All actions sharing this key are associated with the same ServiceNow alert. The default value is `:`.
+ metric_name:
+ type: string
+ description: The name of the metric.
+ node:
+ type: string
+ description: The host that the event was triggered for.
+ resource:
+ type: string
+ description: The name of the resource.
+ severity:
+ type: string
+ description: The severity of the event.
+ source:
+ type: string
+ description: The name of the event source type.
+ time_of_event:
+ type: string
+ description: The time of the event.
+ type:
+ type: string
+ description: The type of event.
+ run_closealert:
+ title: The closeAlert subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `closeAlert` subaction for Opsgenie connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - closeAlert
+ subActionParams:
+ type: object
+ required:
+ - alias
+ properties:
+ alias:
+ type: string
+ description: The unique identifier used for alert deduplication in Opsgenie. The alias must match the value used when creating the alert.
+ note:
+ type: string
+ description: Additional information for the alert.
+ source:
+ type: string
+ description: The display name for the source of the alert.
+ user:
+ type: string
+ description: The display name for the owner.
+ run_closeincident:
+ title: The closeIncident subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `closeIncident` subaction for ServiceNow ITSM connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - closeIncident
+ subActionParams:
+ type: object
+ required:
+ - incident
+ properties:
+ incident:
+ type: object
+ anyOf:
+ - required:
+ - correlation_id
+ - required:
+ - externalId
+ properties:
+ correlation_id:
+ type: string
+ nullable: true
+ description: |
+ An identifier that is assigned to the incident when it is created by the connector. NOTE: If you use the default value and the rule generates multiple alerts that use the same alert IDs, the latest open incident for this correlation ID is closed unless you specify the external ID.
+ maxLength: 100
+ default: '{{rule.id}}:{{alert.id}}'
+ externalId:
+ type: string
+ nullable: true
+ description: The unique identifier (`incidentId`) for the incident in ServiceNow.
+ run_createalert:
+ title: The createAlert subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `createAlert` subaction for Opsgenie and TheHive connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - createAlert
+ subActionParams:
+ type: object
+ properties:
+ actions:
+ type: array
+ description: The custom actions available to the alert in Opsgenie connectors.
+ items:
+ type: string
+ alias:
+ type: string
+ description: The unique identifier used for alert deduplication in Opsgenie.
+ description:
+ type: string
+ description: A description that provides detailed information about the alert.
+ details:
+ type: object
+ description: The custom properties of the alert in Opsgenie connectors.
+ additionalProperties: true
+ example:
+ key1: value1
+ key2: value2
+ entity:
+ type: string
+ description: The domain of the alert in Opsgenie connectors. For example, the application or server name.
+ message:
+ type: string
+ description: The alert message in Opsgenie connectors.
+ note:
+ type: string
+ description: Additional information for the alert in Opsgenie connectors.
+ priority:
+ type: string
+ description: The priority level for the alert in Opsgenie connectors.
+ enum:
+ - P1
+ - P2
+ - P3
+ - P4
+ - P5
+ responders:
+ type: array
+ description: |
+ The entities to receive notifications about the alert in Opsgenie connectors. If `type` is `user`, either `id` or `username` is required. If `type` is `team`, either `id` or `name` is required.
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The identifier for the entity.
+ name:
+ type: string
+ description: The name of the entity.
+ type:
+ type: string
+ description: The type of responders, in this case `escalation`.
+ enum:
+ - escalation
+ - schedule
+ - team
+ - user
+ username:
+ type: string
+ description: A valid email address for the user.
+ severity:
+ type: integer
+ minimum: 1
+ maximum: 4
+ description: |
+ The severity of the incident for TheHive connectors. The value ranges from 1 (low) to 4 (critical) with a default value of 2 (medium).
+ source:
+ type: string
+ description: The display name for the source of the alert in Opsgenie and TheHive connectors.
+ sourceRef:
+ type: string
+ description: A source reference for the alert in TheHive connectors.
+ tags:
+ type: array
+ description: The tags for the alert in Opsgenie and TheHive connectors.
+ items:
+ type: string
+ title:
+ type: string
+ description: |
+ A title for the incident for TheHive connectors. It is used for searching the contents of the knowledge base.
+ tlp:
+ type: integer
+ minimum: 0
+ maximum: 4
+ default: 2
+ description: |
+ The traffic light protocol designation for the incident in TheHive connectors. Valid values include: 0 (clear), 1 (green), 2 (amber), 3 (amber and strict), and 4 (red).
+ type:
+ type: string
+ description: The type of alert in TheHive connectors.
+ user:
+ type: string
+ description: The display name for the owner.
+ visibleTo:
+ type: array
+ description: The teams and users that the alert will be visible to without sending a notification. Only one of `id`, `name`, or `username` is required.
+ items:
+ type: object
+ required:
+ - type
+ properties:
+ id:
+ type: string
+ description: The identifier for the entity.
+ name:
+ type: string
+ description: The name of the entity.
+ type:
+ type: string
+ description: Valid values are `team` and `user`.
+ enum:
+ - team
+ - user
+ username:
+ type: string
+ description: The user name. This property is required only when the `type` is `user`.
+ run_fieldsbyissuetype:
+ title: The fieldsByIssueType subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `fieldsByIssueType` subaction for Jira connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - fieldsByIssueType
+ subActionParams:
+ type: object
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: The Jira issue type identifier.
+ example: 10024
+ run_getchoices:
+ title: The getChoices subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `getChoices` subaction for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - getChoices
+ subActionParams:
+ type: object
+ description: The set of configuration properties for the action.
+ required:
+ - fields
+ properties:
+ fields:
+ type: array
+ description: An array of fields.
+ items:
+ type: string
+ run_getfields:
+ title: The getFields subaction
+ type: object
+ required:
+ - subAction
+ description: The `getFields` subaction for Jira, ServiceNow ITSM, and ServiceNow SecOps connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - getFields
+ run_getincident:
+ title: The getIncident subaction
+ type: object
+ description: The `getIncident` subaction for Jira, ServiceNow ITSM, and ServiceNow SecOps connectors.
+ required:
+ - subAction
+ - subActionParams
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - getIncident
+ subActionParams:
+ type: object
+ required:
+ - externalId
+ properties:
+ externalId:
+ type: string
+ description: The Jira, ServiceNow ITSM, or ServiceNow SecOps issue identifier.
+ example: 71778
+ run_issue:
+ title: The issue subaction
+ type: object
+ required:
+ - subAction
+ description: The `issue` subaction for Jira connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - issue
+ subActionParams:
+ type: object
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: The Jira issue identifier.
+ example: 71778
+ run_issues:
+ title: The issues subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `issues` subaction for Jira connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - issues
+ subActionParams:
+ type: object
+ required:
+ - title
+ properties:
+ title:
+ type: string
+ description: The title of the Jira issue.
+ run_issuetypes:
+ title: The issueTypes subaction
+ type: object
+ required:
+ - subAction
+ description: The `issueTypes` subaction for Jira connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - issueTypes
+ run_postmessage:
+ title: The postMessage subaction
+ type: object
+ description: |
+ Test an action that sends a message to Slack. It is applicable only when the connector type is `.slack_api`.
+ required:
+ - subAction
+ - subActionParams
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - postMessage
+ subActionParams:
+ type: object
+ description: The set of configuration properties for the action.
+ properties:
+ channelIds:
+ type: array
+ maxItems: 1
+ description: |
+ The Slack channel identifier, which must be one of the `allowedChannels` in the connector configuration.
+ items:
+ type: string
+ channels:
+ type: array
+ deprecated: true
+ description: |
+ The name of a channel that your Slack app has access to.
+ maxItems: 1
+ items:
+ type: string
+ text:
+ type: string
+ description: |
+ The Slack message text. If it is a Slack webhook connector, the text cannot contain Markdown, images, or other advanced formatting. If it is a Slack web API connector, it can contain either plain text or block kit messages.
+ minLength: 1
+ run_pushtoservice:
+ title: The pushToService subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `pushToService` subaction for Jira, ServiceNow ITSM, ServiceNow SecOps, Swimlane, TheHive, and Webhook - Case Management connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - pushToService
+ subActionParams:
+ type: object
+ description: The set of configuration properties for the action.
+ properties:
+ comments:
+ type: array
+ description: Additional information that is sent to Jira, ServiceNow ITSM, ServiceNow SecOps, Swimlane, or TheHive.
+ items:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: A comment related to the incident. For example, describe how to troubleshoot the issue.
+ commentId:
+ type: integer
+ description: A unique identifier for the comment.
+ incident:
+ type: object
+ description: Information necessary to create or update a Jira, ServiceNow ITSM, ServiveNow SecOps, Swimlane, or TheHive incident.
+ properties:
+ additional_fields:
+ type: string
+ nullable: true
+ maxLength: 20
+ description: |
+ Additional fields for ServiceNow ITSM and ServiveNow SecOps connectors. The fields must exist in the Elastic ServiceNow application and must be specified in JSON format.
+ alertId:
+ type: string
+ description: The alert identifier for Swimlane connectors.
+ caseId:
+ type: string
+ description: The case identifier for the incident for Swimlane connectors.
+ caseName:
+ type: string
+ description: The case name for the incident for Swimlane connectors.
+ category:
+ type: string
+ description: The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
+ correlation_display:
+ type: string
+ description: A descriptive label of the alert for correlation purposes for ServiceNow ITSM and ServiceNow SecOps connectors.
+ correlation_id:
+ type: string
+ description: |
+ The correlation identifier for the security incident for ServiceNow ITSM and ServiveNow SecOps connectors. Connectors using the same correlation ID are associated with the same ServiceNow incident. This value determines whether a new ServiceNow incident is created or an existing one is updated. Modifying this value is optional; if not modified, the rule ID and alert ID are combined as `{{ruleID}}:{{alert ID}}` to form the correlation ID value in ServiceNow. The maximum character length for this value is 100 characters. NOTE: Using the default configuration of `{{ruleID}}:{{alert ID}}` ensures that ServiceNow creates a separate incident record for every generated alert that uses a unique alert ID. If the rule generates multiple alerts that use the same alert IDs, ServiceNow creates and continually updates a single incident record for the alert.
+ description:
+ type: string
+ description: The description of the incident for Jira, ServiceNow ITSM, ServiceNow SecOps, Swimlane, TheHive, and Webhook - Case Management connectors.
+ dest_ip:
+ description: |
+ A list of destination IP addresses related to the security incident for ServiceNow SecOps connectors. The IPs are added as observables to the security incident.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ externalId:
+ type: string
+ description: |
+ The Jira, ServiceNow ITSM, or ServiceNow SecOps issue identifier. If present, the incident is updated. Otherwise, a new incident is created.
+ id:
+ type: string
+ description: The external case identifier for Webhook - Case Management connectors.
+ impact:
+ type: string
+ description: The impact of the incident for ServiceNow ITSM connectors.
+ issueType:
+ type: integer
+ description: The type of incident for Jira connectors. For example, 10006. To obtain the list of valid values, set `subAction` to `issueTypes`.
+ labels:
+ type: array
+ items:
+ type: string
+ description: |
+ The labels for the incident for Jira connectors. NOTE: Labels cannot contain spaces.
+ malware_hash:
+ description: A list of malware hashes related to the security incident for ServiceNow SecOps connectors. The hashes are added as observables to the security incident.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ malware_url:
+ type: string
+ description: A list of malware URLs related to the security incident for ServiceNow SecOps connectors. The URLs are added as observables to the security incident.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ otherFields:
+ type: object
+ additionalProperties: true
+ maxProperties: 20
+ description: |
+ Custom field identifiers and their values for Jira connectors.
+ parent:
+ type: string
+ description: The ID or key of the parent issue for Jira connectors. Applies only to `Sub-task` types of issues.
+ priority:
+ type: string
+ description: The priority of the incident in Jira and ServiceNow SecOps connectors.
+ ruleName:
+ type: string
+ description: The rule name for Swimlane connectors.
+ severity:
+ type: integer
+ description: |
+ The severity of the incident for ServiceNow ITSM, Swimlane, and TheHive connectors. In TheHive connectors, the severity value ranges from 1 (low) to 4 (critical) with a default value of 2 (medium).
+ short_description:
+ type: string
+ description: |
+ A short description of the incident for ServiceNow ITSM and ServiceNow SecOps connectors. It is used for searching the contents of the knowledge base.
+ source_ip:
+ description: A list of source IP addresses related to the security incident for ServiceNow SecOps connectors. The IPs are added as observables to the security incident.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ status:
+ type: string
+ description: The status of the incident for Webhook - Case Management connectors.
+ subcategory:
+ type: string
+ description: The subcategory of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
+ summary:
+ type: string
+ description: A summary of the incident for Jira connectors.
+ tags:
+ type: array
+ items:
+ type: string
+ description: A list of tags for TheHive and Webhook - Case Management connectors.
+ title:
+ type: string
+ description: |
+ A title for the incident for Jira, TheHive, and Webhook - Case Management connectors. It is used for searching the contents of the knowledge base.
+ tlp:
+ type: integer
+ minimum: 0
+ maximum: 4
+ default: 2
+ description: |
+ The traffic light protocol designation for the incident in TheHive connectors. Valid values include: 0 (clear), 1 (green), 2 (amber), 3 (amber and strict), and 4 (red).
+ urgency:
+ type: string
+ description: The urgency of the incident for ServiceNow ITSM connectors.
+ run_validchannelid:
+ title: The validChannelId subaction
+ type: object
+ description: |
+ Retrieves information about a valid Slack channel identifier. It is applicable only when the connector type is `.slack_api`.
+ required:
+ - subAction
+ - subActionParams
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - validChannelId
+ subActionParams:
+ type: object
+ required:
+ - channelId
+ properties:
+ channelId:
+ type: string
+ description: The Slack channel identifier.
+ example: C123ABC456
+ params_property_apm_anomaly:
+ required:
+ - windowSize
+ - windowUnit
+ - environment
+ - anomalySeverityType
+ properties:
+ serviceName:
+ type: string
+ description: The service name from APM
+ transactionType:
+ type: string
+ description: The transaction type from APM
+ windowSize:
+ type: number
+ example: 6
+ description: The window size
+ windowUnit:
+ type: string
+ description: The window size unit
+ enum:
+ - m
+ - h
+ - d
+ environment:
+ type: string
+ description: The environment from APM
+ anomalySeverityType:
+ type: string
+ description: The anomaly threshold value
+ enum:
+ - critical
+ - major
+ - minor
+ - warning
+ params_property_apm_error_count:
+ required:
+ - windowSize
+ - windowUnit
+ - threshold
+ - environment
+ properties:
+ serviceName:
+ type: string
+ description: The service name from APM
+ windowSize:
+ type: number
+ description: The window size
+ example: 6
+ windowUnit:
+ type: string
+ description: The window size unit
+ enum:
+ - m
+ - h
+ - d
+ environment:
+ type: string
+ description: The environment from APM
+ threshold:
+ type: number
+ description: The error count threshold value
+ groupBy:
+ type: array
+ default:
+ - service.name
+ - service.environment
+ uniqueItems: true
+ items:
+ type: string
+ enum:
+ - service.name
+ - service.environment
+ - transaction.name
+ - error.grouping_key
+ errorGroupingKey:
+ type: string
+ params_property_apm_transaction_duration:
+ required:
+ - windowSize
+ - windowUnit
+ - threshold
+ - environment
+ - aggregationType
+ properties:
+ serviceName:
+ type: string
+ description: The service name from APM
+ transactionType:
+ type: string
+ description: The transaction type from APM
+ transactionName:
+ type: string
+ description: The transaction name from APM
+ windowSize:
+ type: number
+ description: The window size
+ example: 6
+ windowUnit:
+ type: string
+ description: ç
+ enum:
+ - m
+ - h
+ - d
+ environment:
+ type: string
+ threshold:
+ type: number
+ description: The latency threshold value
+ groupBy:
+ type: array
+ default:
+ - service.name
+ - service.environment
+ - transaction.type
+ uniqueItems: true
+ items:
+ type: string
+ enum:
+ - service.name
+ - service.environment
+ - transaction.type
+ - transaction.name
+ aggregationType:
+ type: string
+ enum:
+ - avg
+ - 95th
+ - 99th
+ params_property_apm_transaction_error_rate:
+ required:
+ - windowSize
+ - windowUnit
+ - threshold
+ - environment
+ properties:
+ serviceName:
+ type: string
+ description: The service name from APM
+ transactionType:
+ type: string
+ description: The transaction type from APM
+ transactionName:
+ type: string
+ description: The transaction name from APM
+ windowSize:
+ type: number
+ description: The window size
+ example: 6
+ windowUnit:
+ type: string
+ description: The window size unit
+ enum:
+ - m
+ - h
+ - d
+ environment:
+ type: string
+ description: The environment from APM
+ threshold:
+ type: number
+ description: The error rate threshold value
+ groupBy:
+ type: array
+ default:
+ - service.name
+ - service.environment
+ - transaction.type
+ uniqueItems: true
+ items:
+ type: string
+ enum:
+ - service.name
+ - service.environment
+ - transaction.type
+ - transaction.name
+ aggfield:
+ description: |
+ The name of the numeric field that is used in the aggregation. This property is required when `aggType` is `avg`, `max`, `min` or `sum`.
+ type: string
+ aggtype:
+ description: The type of aggregation to perform.
+ type: string
+ enum:
+ - avg
+ - count
+ - max
+ - min
+ - sum
+ default: count
+ excludehitsfrompreviousrun:
+ description: |
+ Indicates whether to exclude matches from previous runs. If `true`, you can avoid alert duplication by excluding documents that have already been detected by the previous rule run. This option is not available when a grouping field is specified.
+ type: boolean
+ groupby:
+ description: |
+ Indicates whether the aggregation is applied over all documents (`all`) or split into groups (`top`) using a grouping field (`termField`). If grouping is used, an alert will be created for each group when it exceeds the threshold; only the top groups (up to `termSize` number of groups) are checked.
+ type: string
+ enum:
+ - all
+ - top
+ default: all
+ size:
+ description: |
+ The number of documents to pass to the configured actions when the threshold condition is met.
+ type: integer
+ termfield:
+ description: |
+ The names of up to four fields that are used for grouping the aggregation. This property is required when `groupBy` is `top`.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ maxItems: 4
+ termsize:
+ description: |
+ This property is required when `groupBy` is `top`. It specifies the number of groups to check against the threshold and therefore limits the number of alerts on high cardinality fields.
+ type: integer
+ threshold:
+ description: |
+ The threshold value that is used with the `thresholdComparator`. If the `thresholdComparator` is `between` or `notBetween`, you must specify the boundary values.
+ type: array
+ items:
+ type: integer
+ example: 4000
+ thresholdcomparator:
+ description: The comparison function for the threshold. For example, "is above", "is above or equals", "is below", "is below or equals", "is between", and "is not between".
+ type: string
+ enum:
+ - '>'
+ - '>='
+ - <
+ - <=
+ - between
+ - notBetween
+ example: '>'
+ timefield:
+ description: The field that is used to calculate the time window.
+ type: string
+ timewindowsize:
+ description: |
+ The size of the time window (in `timeWindowUnit` units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
+ type: integer
+ example: 5
+ timewindowunit:
+ description: |
+ The type of units for the time window: seconds, minutes, hours, or days.
+ type: string
+ enum:
+ - s
+ - m
+ - h
+ - d
+ example: m
+ params_es_query_dsl_rule:
+ title: Elasticsearch DSL query rule params
+ description: |
+ An Elasticsearch query rule can run a query defined in Elasticsearch Query DSL and compare the number of matches to a configured threshold. These parameters are appropriate when `rule_type_id` is `.es-query`.
+ type: object
+ required:
+ - esQuery
+ - index
+ - threshold
+ - thresholdComparator
+ - timeField
+ - timeWindowSize
+ - timeWindowUnit
+ properties:
+ aggField:
+ $ref: '#/components/schemas/aggfield'
+ aggType:
+ $ref: '#/components/schemas/aggtype'
+ esQuery:
+ description: The query definition, which uses Elasticsearch Query DSL.
+ type: string
+ excludeHitsFromPreviousRun:
+ $ref: '#/components/schemas/excludehitsfrompreviousrun'
+ groupBy:
+ $ref: '#/components/schemas/groupby'
+ index:
+ description: The indices to query.
+ oneOf:
+ - type: array
+ items:
+ type: string
+ - type: string
+ searchType:
+ description: The type of query, in this case a query that uses Elasticsearch Query DSL.
+ type: string
+ enum:
+ - esQuery
+ default: esQuery
+ example: esQuery
+ size:
+ $ref: '#/components/schemas/size'
+ termField:
+ $ref: '#/components/schemas/termfield'
+ termSize:
+ $ref: '#/components/schemas/termsize'
+ threshold:
+ $ref: '#/components/schemas/threshold'
+ thresholdComparator:
+ $ref: '#/components/schemas/thresholdcomparator'
+ timeField:
+ $ref: '#/components/schemas/timefield'
+ timeWindowSize:
+ $ref: '#/components/schemas/timewindowsize'
+ timeWindowUnit:
+ $ref: '#/components/schemas/timewindowunit'
+ params_es_query_esql_rule:
+ title: Elasticsearch ES|QL query rule params
+ description: |
+ An Elasticsearch query rule can run an ES|QL query and compare the number of matches to a configured threshold. These parameters are appropriate when `rule_type_id` is `.es-query`.
+ type: object
+ required:
+ - esqlQuery
+ - searchType
+ - size
+ - threshold
+ - thresholdComparator
+ - timeWindowSize
+ - timeWindowUnit
+ properties:
+ aggField:
+ $ref: '#/components/schemas/aggfield'
+ aggType:
+ $ref: '#/components/schemas/aggtype'
+ esqlQuery:
+ type: object
+ required:
+ - esql
+ properties:
+ esql:
+ description: The query definition, which uses Elasticsearch Query Language.
+ type: string
+ excludeHitsFromPreviousRun:
+ $ref: '#/components/schemas/excludehitsfrompreviousrun'
+ groupBy:
+ $ref: '#/components/schemas/groupby'
+ searchType:
+ description: The type of query, in this case a query that uses Elasticsearch Query Language (ES|QL).
+ type: string
+ enum:
+ - esqlQuery
+ example: esqlQuery
+ size:
+ type: integer
+ description: |
+ When `searchType` is `esqlQuery`, this property is required but it does not affect the rule behavior.
+ example: 0
+ termSize:
+ $ref: '#/components/schemas/termsize'
+ threshold:
+ type: array
+ items:
+ type: integer
+ minimum: 0
+ maximum: 0
+ description: |
+ The threshold value that is used with the `thresholdComparator`. When `searchType` is `esqlQuery`, this property is required and must be set to zero.
+ thresholdComparator:
+ type: string
+ description: |
+ The comparison function for the threshold. When `searchType` is `esqlQuery`, this property is required and must be set to ">". Since the `threshold` value must be `0`, the result is that an alert occurs whenever the query returns results.
+ enum:
+ - '>'
+ example: '>'
+ timeField:
+ $ref: '#/components/schemas/timefield'
+ timeWindowSize:
+ $ref: '#/components/schemas/timewindowsize'
+ timeWindowUnit:
+ $ref: '#/components/schemas/timewindowunit'
+ filter:
+ type: object
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
+ properties:
+ meta:
+ type: object
+ properties:
+ alias:
+ type: string
+ nullable: true
+ controlledBy:
+ type: string
+ disabled:
+ type: boolean
+ field:
+ type: string
+ group:
+ type: string
+ index:
+ type: string
+ isMultiIndex:
+ type: boolean
+ key:
+ type: string
+ negate:
+ type: boolean
+ params:
+ type: object
+ type:
+ type: string
+ value:
+ type: string
+ query:
+ type: object
+ $state:
+ type: object
+ params_es_query_kql_rule:
+ title: Elasticsearch KQL query rule params
+ description: |
+ An Elasticsearch query rule can run a query defined in KQL or Lucene and compare the number of matches to a configured threshold. These parameters are appropriate when `rule_type_id` is `.es-query`.
+ type: object
+ required:
+ - searchType
+ - size
+ - threshold
+ - thresholdComparator
+ - timeWindowSize
+ - timeWindowUnit
+ properties:
+ aggField:
+ $ref: '#/components/schemas/aggfield'
+ aggType:
+ $ref: '#/components/schemas/aggtype'
+ excludeHitsFromPreviousRun:
+ $ref: '#/components/schemas/excludehitsfrompreviousrun'
+ groupBy:
+ $ref: '#/components/schemas/groupby'
+ searchConfiguration:
+ description: The query definition, which uses KQL or Lucene to fetch the documents from Elasticsearch.
+ type: object
+ properties:
+ filter:
+ type: array
+ items:
+ $ref: '#/components/schemas/filter'
+ index:
+ description: The indices to query.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ query:
+ type: object
+ properties:
+ language:
+ type: string
+ example: kuery
+ query:
+ type: string
+ searchType:
+ description: The type of query, in this case a text-based query that uses KQL or Lucene.
+ type: string
+ enum:
+ - searchSource
+ example: searchSource
+ size:
+ $ref: '#/components/schemas/size'
+ termField:
+ $ref: '#/components/schemas/termfield'
+ termSize:
+ $ref: '#/components/schemas/termsize'
+ threshold:
+ $ref: '#/components/schemas/threshold'
+ thresholdComparator:
+ $ref: '#/components/schemas/thresholdcomparator'
+ timeField:
+ $ref: '#/components/schemas/timefield'
+ timeWindowSize:
+ $ref: '#/components/schemas/timewindowsize'
+ timeWindowUnit:
+ $ref: '#/components/schemas/timewindowunit'
+ params_index_threshold_rule:
+ title: Index threshold rule params
+ description: An index threshold rule runs an Elasticsearch query, aggregates field values from documents, compares them to threshold values, and schedules actions to run when the thresholds are met. These parameters are appropriate when `rule_type_id` is `.index-threshold`.
+ type: object
+ required:
+ - index
+ - threshold
+ - thresholdComparator
+ - timeField
+ - timeWindowSize
+ - timeWindowUnit
+ properties:
+ aggField:
+ $ref: '#/components/schemas/aggfield'
+ aggType:
+ $ref: '#/components/schemas/aggtype'
+ filterKuery:
+ description: A KQL expression thats limits the scope of alerts.
+ type: string
+ groupBy:
+ $ref: '#/components/schemas/groupby'
+ index:
+ description: The indices to query.
+ type: array
+ items:
+ type: string
+ termField:
+ $ref: '#/components/schemas/termfield'
+ termSize:
+ $ref: '#/components/schemas/termsize'
+ threshold:
+ $ref: '#/components/schemas/threshold'
+ thresholdComparator:
+ $ref: '#/components/schemas/thresholdcomparator'
+ timeField:
+ $ref: '#/components/schemas/timefield'
+ timeWindowSize:
+ $ref: '#/components/schemas/timewindowsize'
+ timeWindowUnit:
+ $ref: '#/components/schemas/timewindowunit'
+ params_property_infra_inventory:
+ properties:
+ criteria:
+ type: array
+ items:
+ type: object
+ properties:
+ metric:
+ type: string
+ enum:
+ - count
+ - cpu
+ - diskLatency
+ - load
+ - memory
+ - memoryTotal
+ - tx
+ - rx
+ - logRate
+ - diskIOReadBytes
+ - diskIOWriteBytes
+ - s3TotalRequests
+ - s3NumberOfObjects
+ - s3BucketSize
+ - s3DownloadBytes
+ - s3UploadBytes
+ - rdsConnections
+ - rdsQueriesExecuted
+ - rdsActiveTransactions
+ - rdsLatency
+ - sqsMessagesVisible
+ - sqsMessagesDelayed
+ - sqsMessagesSent
+ - sqsMessagesEmpty
+ - sqsOldestMessage
+ - custom
+ timeSize:
+ type: number
+ timeUnit:
+ type: string
+ enum:
+ - s
+ - m
+ - h
+ - d
+ sourceId:
+ type: string
+ threshold:
+ type: array
+ items:
+ type: number
+ comparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ customMetric:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - custom
+ field:
+ type: string
+ aggregation:
+ type: string
+ enum:
+ - avg
+ - max
+ - min
+ - rate
+ id:
+ type: string
+ label:
+ type: string
+ warningThreshold:
+ type: array
+ items:
+ type: number
+ warningComparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ filterQuery:
+ type: string
+ filterQueryText:
+ type: string
+ nodeType:
+ type: string
+ enum:
+ - host
+ - pod
+ - container
+ - awsEC2
+ - awsS3
+ - awsSQS
+ - awsRDS
+ sourceId:
+ type: string
+ alertOnNoData:
+ type: boolean
+ params_property_log_threshold:
+ oneOf:
+ - title: Count
+ type: object
+ required:
+ - count
+ - timeSize
+ - timeUnit
+ - logView
+ properties:
+ criteria:
+ type: array
+ items:
+ type: object
+ properties:
+ field:
+ type: string
+ example: my.field
+ comparator:
+ type: string
+ enum:
+ - more than
+ - more than or equals
+ - less than
+ - less than or equals
+ - equals
+ - does not equal
+ - matches
+ - does not match
+ - matches phrase
+ - does not match phrase
+ value:
+ oneOf:
+ - type: number
+ example: 42
+ - type: string
+ example: value
+ count:
+ type: object
+ properties:
+ comparator:
+ type: string
+ enum:
+ - more than
+ - more than or equals
+ - less than
+ - less than or equals
+ - equals
+ - does not equal
+ - matches
+ - does not match
+ - matches phrase
+ - does not match phrase
+ value:
+ type: number
+ example: 100
+ timeSize:
+ type: number
+ example: 6
+ timeUnit:
+ type: string
+ enum:
+ - s
+ - m
+ - h
+ - d
+ logView:
+ type: object
+ properties:
+ logViewId:
+ type: string
+ type:
+ type: string
+ enum:
+ - log-view-reference
+ example: log-view-reference
+ groupBy:
+ type: array
+ items:
+ type: string
+ - title: Ratio
+ type: object
+ required:
+ - count
+ - timeSize
+ - timeUnit
+ - logView
+ properties:
+ criteria:
+ type: array
+ items:
+ minItems: 2
+ maxItems: 2
+ type: array
+ items:
+ type: object
+ properties:
+ field:
+ type: string
+ example: my.field
+ comparator:
+ type: string
+ enum:
+ - more than
+ - more than or equals
+ - less than
+ - less than or equals
+ - equals
+ - does not equal
+ - matches
+ - does not match
+ - matches phrase
+ - does not match phrase
+ value:
+ oneOf:
+ - type: number
+ example: 42
+ - type: string
+ example: value
+ count:
+ type: object
+ properties:
+ comparator:
+ type: string
+ enum:
+ - more than
+ - more than or equals
+ - less than
+ - less than or equals
+ - equals
+ - does not equal
+ - matches
+ - does not match
+ - matches phrase
+ - does not match phrase
+ value:
+ type: number
+ example: 100
+ timeSize:
+ type: number
+ example: 6
+ timeUnit:
+ type: string
+ enum:
+ - s
+ - m
+ - h
+ - d
+ logView:
+ type: object
+ properties:
+ logViewId:
+ type: string
+ type:
+ type: string
+ enum:
+ - log-view-reference
+ example: log-view-reference
+ groupBy:
+ type: array
+ items:
+ type: string
+ params_property_infra_metric_threshold:
+ properties:
+ criteria:
+ type: array
+ items:
+ oneOf:
+ - title: non count criterion
+ type: object
+ properties:
+ threshold:
+ type: array
+ items:
+ type: number
+ comparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ timeUnit:
+ type: string
+ timeSize:
+ type: number
+ warningThreshold:
+ type: array
+ items:
+ type: number
+ warningComparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ metric:
+ type: string
+ aggType:
+ type: string
+ enum:
+ - avg
+ - max
+ - min
+ - cardinality
+ - rate
+ - count
+ - sum
+ - p95
+ - p99
+ - custom
+ - title: count criterion
+ type: object
+ properties:
+ threshold:
+ type: array
+ items:
+ type: number
+ comparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ timeUnit:
+ type: string
+ timeSize:
+ type: number
+ warningThreshold:
+ type: array
+ items:
+ type: number
+ warningComparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ aggType:
+ type: string
+ enum:
+ - count
+ - title: custom criterion
+ type: object
+ properties:
+ threshold:
+ type: array
+ items:
+ type: number
+ comparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ timeUnit:
+ type: string
+ timeSize:
+ type: number
+ warningThreshold:
+ type: array
+ items:
+ type: number
+ warningComparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ aggType:
+ type: string
+ enum:
+ - custom
+ customMetric:
+ type: array
+ items:
+ oneOf:
+ - type: object
+ properties:
+ name:
+ type: string
+ aggType:
+ type: string
+ enum:
+ - avg
+ - sum
+ - max
+ - min
+ - cardinality
+ field:
+ type: string
+ - type: object
+ properties:
+ name:
+ type: string
+ aggType:
+ type: string
+ enum:
+ - count
+ filter:
+ type: string
+ equation:
+ type: string
+ label:
+ type: string
+ groupBy:
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ filterQuery:
+ type: string
+ sourceId:
+ type: string
+ alertOnNoData:
+ type: boolean
+ alertOnGroupDisappear:
+ type: boolean
+ params_property_slo_burn_rate:
+ properties:
+ sloId:
+ description: The SLO identifier used by the rule
+ type: string
+ example: 8853df00-ae2e-11ed-90af-09bb6422b258
+ burnRateThreshold:
+ description: The burn rate threshold used to trigger the alert
+ type: number
+ example: 14.4
+ maxBurnRateThreshold:
+ description: The maximum burn rate threshold value defined by the SLO error budget
+ type: number
+ example: 168
+ longWindow:
+ description: The duration of the long window used to compute the burn rate
+ type: object
+ properties:
+ value:
+ description: The duration value
+ type: number
+ example: 6
+ unit:
+ description: The duration unit
+ type: string
+ example: h
+ shortWindow:
+ description: The duration of the short window used to compute the burn rate
+ type: object
+ properties:
+ value:
+ description: The duration value
+ type: number
+ example: 30
+ unit:
+ description: The duration unit
+ type: string
+ example: m
+ params_property_synthetics_uptime_tls:
+ properties:
+ search:
+ type: string
+ certExpirationThreshold:
+ type: number
+ certAgeThreshold:
+ type: number
+ params_property_synthetics_monitor_status:
+ required:
+ - numTimes
+ - shouldCheckStatus
+ - shouldCheckAvailability
+ properties:
+ availability:
+ type: object
+ properties:
+ range:
+ type: number
+ rangeUnit:
+ type: string
+ threshold:
+ type: string
+ filters:
+ oneOf:
+ - type: string
+ - type: object
+ deprecated: true
+ properties:
+ monitor.type:
+ type: array
+ items:
+ type: string
+ observer.geo.name:
+ type: array
+ items:
+ type: string
+ tags:
+ type: array
+ items:
+ type: string
+ url.port:
+ type: array
+ items:
+ type: string
+ locations:
+ deprecated: true
+ type: array
+ items:
+ type: string
+ numTimes:
+ type: number
+ search:
+ type: string
+ shouldCheckStatus:
+ type: boolean
+ shouldCheckAvailability:
+ type: boolean
+ timerangeCount:
+ type: number
+ timerangeUnit:
+ type: string
+ timerange:
+ deprecated: true
+ type: object
+ properties:
+ from:
+ type: string
+ to:
+ type: string
+ version:
+ type: number
+ isAutoGenerated:
+ type: boolean
+ securitySchemes:
+ apiKeyAuth:
+ description: You must create an API key and use the encoded value in the request header. To learn about creating keys, go to [API keys](https://www.elastic.co/docs/current/serverless/api-keys).
+ in: header
+ name: Authorization
+ type: apiKey
diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
index db3282f2c7899..94e987510c649 100644
--- a/oas_docs/output/kibana.yaml
+++ b/oas_docs/output/kibana.yaml
@@ -2,68 +2,38 @@ openapi: 3.0.3
info:
contact:
name: Kibana Team
- description: >
- The Kibana REST APIs enable you to manage resources such as connectors, data
- views, and saved objects.
-
+ description: |
+ The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
The API calls are stateless.
-
- Each request that you make happens in isolation from other calls and must
- include all of the necessary information for Kibana to fulfill the
-
+ Each request that you make happens in isolation from other calls and must include all of the necessary information for Kibana to fulfill the
request.
-
- API requests return JSON output, which is a format that is machine-readable
- and works well for automation.
-
+ API requests return JSON output, which is a format that is machine-readable and works well for automation.
To interact with Kibana APIs, use the following operations:
-
- GET: Fetches the information.
-
- PATCH: Applies partial modifications to the existing information.
-
- POST: Adds new information.
-
- PUT: Updates the existing information.
-
- DELETE: Removes the information.
-
- You can prepend any Kibana API endpoint with `kbn:` and run the request in
- **Dev Tools → Console**.
-
+ You can prepend any Kibana API endpoint with `kbn:` and run the request in **Dev Tools → Console**.
For example:
-
```
-
GET kbn:/api/data_views
-
```
+ For more information about the console, refer to [Run API requests](https://www.elastic.co/guide/en/kibana/current/console-kibana.html).
- For more information about the console, refer to [Run API
- requests](https://www.elastic.co/guide/en/kibana/current/console-kibana.html).
-
-
- NOTE: Access to internal Kibana API endpoints will be restricted in Kibana
- version 9.0. Please move any integrations to publicly documented APIs.
-
+ NOTE: Access to internal Kibana API endpoints will be restricted in Kibana version 9.0. Please move any integrations to publicly documented APIs.
## Documentation source and versions
+ This documentation is derived from the `main` branch of the [kibana](https://github.com/elastic/kibana) repository.
+ It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
- This documentation is derived from the `main` branch of the
- [kibana](https://github.com/elastic/kibana) repository.
-
- It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0
- International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
-
-
- This documentation contains work-in-progress information for future Elastic
- Stack releases.
+ This documentation contains work-in-progress information for future Elastic Stack releases.
title: Kibana APIs
version: 1.0.2
x-doc-license:
@@ -71,13 +41,131 @@ info:
url: https://creativecommons.org/licenses/by-nc-nd/4.0/
x-feedbackLink:
label: Feedback
- url: >-
- https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
+ url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: https://{kibana_url}
variables:
kibana_url:
default: localhost:5601
+security:
+ - apiKeyAuth: []
+ - basicAuth: []
+tags:
+ - name: alerting
+ description: |
+ Alerting enables you to define rules, which detect complex conditions within your data. When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule. Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
+ externalDocs:
+ description: Alerting documentation
+ url: https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html
+ x-displayName: Alerting
+ - description: |
+ Adjust APM agent configuration without need to redeploy your application.
+ name: APM agent configuration
+ - description: |
+ Configure APM agent keys to authorize requests from APM agents to the APM Server.
+ name: APM agent keys
+ - description: |
+ Annotate visualizations in the APM app with significant events. Annotations enable you to easily see how events are impacting the performance of your applications.
+ name: APM annotations
+ - description: Create APM fleet server schema.
+ name: APM server schema
+ - description: Configure APM source maps.
+ name: APM sourcemaps
+ - description: |
+ Cases are used to open and track issues. You can add assignees and tags to your cases, set their severity and status, and add alerts, comments, and visualizations. You can also send cases to external incident management systems by configuring connectors.
+ name: cases
+ externalDocs:
+ description: Cases documentation
+ url: https://www.elastic.co/guide/en/kibana/master/cases.html
+ x-displayName: Cases
+ - name: connectors
+ description: |
+ Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems. Alerting rules can use connectors to run actions when rule conditions are met.
+ externalDocs:
+ description: Connector documentation
+ url: https://www.elastic.co/guide/en/kibana/current/action-types.html
+ x-displayName: Connectors
+ - name: Data streams
+ - description: Data view APIs enable you to manage data views, formerly known as Kibana index patterns.
+ name: data views
+ x-displayName: Data views
+ - name: Elastic Agent actions
+ - name: Elastic Agent binary download sources
+ - name: Elastic Agent policies
+ - name: Elastic Agent status
+ - name: Elastic Agents
+ - name: Elastic Package Manager (EPM)
+ - name: Fleet enrollment API keys
+ - name: Fleet internals
+ - name: Fleet outputs
+ - name: Fleet package policies
+ - name: Fleet proxies
+ - name: Fleet Server hosts
+ - name: Fleet service tokens
+ - name: Fleet uninstall tokens
+ - name: Message Signing Service
+ - description: Machine learning
+ name: ml
+ x-displayName: Machine learning
+ - name: roles
+ x-displayName: Roles
+ description: Manage the roles that grant Elasticsearch and Kibana privileges.
+ externalDocs:
+ description: Kibana role management
+ url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
+ - description: |
+ Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
+
+ To manage a specific type of saved object, use the corresponding APIs.
+ For example, use:
+
+ * [Data views](../group/endpoint-data-views)
+ * [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)
+ * [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)
+
+ Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.
+ name: saved objects
+ x-displayName: Saved objects
+ - description: Manage and interact with Security Assistant resources.
+ name: Security AI Assistant API
+ x-displayName: Security AI assistant
+ - description: You can create rules that automatically turn events and external alerts sent to Elastic Security into detection alerts. These alerts are displayed on the Detections page.
+ name: Security Detections API
+ x-displayName: Security detections
+ - description: Endpoint Exceptions API allows you to manage detection rule endpoint exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met.
+ name: Security Endpoint Exceptions API
+ x-displayName: Security endpoint exceptions
+ - description: Interact with and manage endpoints running the Elastic Defend integration.
+ name: Security Endpoint Management API
+ x-displayName: Security endpoint management
+ - description: ''
+ name: Security Entity Analytics API
+ x-displayName: Security entity analytics
+ - description: Exceptions API allows you to manage detection rule exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met.
+ name: Security Exceptions API
+ x-displayName: Security exceptions
+ - description: Lists API allows you to manage lists of keywords, IPs or IP ranges items.
+ name: Security Lists API
+ x-displayName: Security lists
+ - description: Run live queries, manage packs and saved queries.
+ name: Security Osquery API
+ x-displayName: Security Osquery
+ - description: You can create Timelines and Timeline templates via the API, as well as import new Timelines from an ndjson file.
+ name: Security Timeline API
+ x-displayName: Security timeline
+ - description: SLO APIs enable you to define, manage and track service-level objectives
+ name: slo
+ x-displayName: Service level objectives
+ - name: spaces
+ x-displayName: Spaces
+ description: Manage your Kibana spaces.
+ externalDocs:
+ url: https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html
+ description: Space overview
+ - name: system
+ x-displayName: System
+ description: |
+ Get information about the system status, resource usage, and installed plugins.
paths:
/api/actions/connector_types:
get:
@@ -92,15 +180,20 @@ paths:
enum:
- '2023-10-31'
type: string
- - description: >-
- A filter to limit the retrieved connector types to those that
- support a specific feature (such as alerting or cases).
+ - description: A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).
in: query
name: feature_id
required: false
schema:
type: string
- responses: {}
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getConnectorTypesServerlessResponse:
+ $ref: '#/components/examples/get_connector_types_generativeai_response'
summary: Get connector types
tags:
- connectors
@@ -177,15 +270,10 @@ paths:
description: Indicates whether the connector is missing secrets.
type: boolean
is_preconfigured:
- description: >-
- Indicates whether the connector is preconfigured. If true,
- the `config` and `is_missing_secrets` properties are
- omitted from the response.
+ description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. '
type: boolean
is_system_action:
- description: >-
- Indicates whether the connector is used for system
- actions.
+ description: Indicates whether the connector is used for system actions.
type: boolean
name:
description: ' The name of the rule.'
@@ -197,6 +285,9 @@ paths:
- is_preconfigured
- is_deprecated
- is_system_action
+ examples:
+ getConnectorResponse:
+ $ref: '#/components/examples/get_connector_response'
description: Indicates a successful call.
summary: Get connector information
tags:
@@ -222,7 +313,7 @@ paths:
- description: An identifier for the connector.
in: path
name: id
- required: false
+ required: true
schema:
type: string
requestBody:
@@ -232,23 +323,77 @@ paths:
additionalProperties: false
type: object
properties:
- config:
- additionalProperties: {}
- default: {}
- type: object
connector_type_id:
description: The type of connector.
type: string
name:
description: The display name for the connector.
type: string
+ config:
+ additionalProperties: {}
+ default: {}
+ description: The connector configuration details.
+ oneOf:
+ - $ref: '#/components/schemas/bedrock_config'
+ - $ref: '#/components/schemas/crowdstrike_config'
+ - $ref: '#/components/schemas/d3security_config'
+ - $ref: '#/components/schemas/email_config'
+ - $ref: '#/components/schemas/gemini_config'
+ - $ref: '#/components/schemas/resilient_config'
+ - $ref: '#/components/schemas/index_config'
+ - $ref: '#/components/schemas/jira_config'
+ - $ref: '#/components/schemas/genai_azure_config'
+ - $ref: '#/components/schemas/genai_openai_config'
+ - $ref: '#/components/schemas/opsgenie_config'
+ - $ref: '#/components/schemas/pagerduty_config'
+ - $ref: '#/components/schemas/sentinelone_config'
+ - $ref: '#/components/schemas/servicenow_config'
+ - $ref: '#/components/schemas/servicenow_itom_config'
+ - $ref: '#/components/schemas/slack_api_config'
+ - $ref: '#/components/schemas/swimlane_config'
+ - $ref: '#/components/schemas/thehive_config'
+ - $ref: '#/components/schemas/tines_config'
+ - $ref: '#/components/schemas/torq_config'
+ - $ref: '#/components/schemas/webhook_config'
+ - $ref: '#/components/schemas/cases_webhook_config'
+ - $ref: '#/components/schemas/xmatters_config'
secrets:
additionalProperties: {}
default: {}
- type: object
+ oneOf:
+ - $ref: '#/components/schemas/bedrock_secrets'
+ - $ref: '#/components/schemas/crowdstrike_secrets'
+ - $ref: '#/components/schemas/d3security_secrets'
+ - $ref: '#/components/schemas/email_secrets'
+ - $ref: '#/components/schemas/gemini_secrets'
+ - $ref: '#/components/schemas/resilient_secrets'
+ - $ref: '#/components/schemas/jira_secrets'
+ - $ref: '#/components/schemas/teams_secrets'
+ - $ref: '#/components/schemas/genai_secrets'
+ - $ref: '#/components/schemas/opsgenie_secrets'
+ - $ref: '#/components/schemas/pagerduty_secrets'
+ - $ref: '#/components/schemas/sentinelone_secrets'
+ - $ref: '#/components/schemas/servicenow_secrets'
+ - $ref: '#/components/schemas/slack_api_secrets'
+ - $ref: '#/components/schemas/swimlane_secrets'
+ - $ref: '#/components/schemas/thehive_secrets'
+ - $ref: '#/components/schemas/tines_secrets'
+ - $ref: '#/components/schemas/torq_secrets'
+ - $ref: '#/components/schemas/webhook_secrets'
+ - $ref: '#/components/schemas/cases_webhook_secrets'
+ - $ref: '#/components/schemas/xmatters_secrets'
required:
- name
- connector_type_id
+ examples:
+ createEmailConnectorRequest:
+ $ref: '#/components/examples/create_email_connector_request'
+ createIndexConnectorRequest:
+ $ref: '#/components/examples/create_index_connector_request'
+ createWebhookConnectorRequest:
+ $ref: '#/components/examples/create_webhook_connector_request'
+ createXmattersConnectorRequest:
+ $ref: '#/components/examples/create_xmatters_connector_request'
responses:
'200':
content:
@@ -273,15 +418,10 @@ paths:
description: Indicates whether the connector is missing secrets.
type: boolean
is_preconfigured:
- description: >-
- Indicates whether the connector is preconfigured. If true,
- the `config` and `is_missing_secrets` properties are
- omitted from the response.
+ description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. '
type: boolean
is_system_action:
- description: >-
- Indicates whether the connector is used for system
- actions.
+ description: Indicates whether the connector is used for system actions.
type: boolean
name:
description: ' The name of the rule.'
@@ -293,6 +433,15 @@ paths:
- is_preconfigured
- is_deprecated
- is_system_action
+ examples:
+ createEmailConnectorResponse:
+ $ref: '#/components/examples/create_email_connector_response'
+ createIndexConnectorResponse:
+ $ref: '#/components/examples/create_index_connector_response'
+ createWebhookConnectorResponse:
+ $ref: '#/components/examples/create_webhook_connector_response'
+ createXmattersConnectorResponse:
+ $ref: '#/components/examples/get_connector_response'
description: Indicates a successful call.
summary: Create a connector
tags:
@@ -328,19 +477,67 @@ paths:
additionalProperties: false
type: object
properties:
- config:
- additionalProperties: {}
- default: {}
- type: object
name:
description: The display name for the connector.
type: string
+ config:
+ additionalProperties: {}
+ default: {}
+ description: The connector configuration details.
+ oneOf:
+ - $ref: '#/components/schemas/bedrock_config'
+ - $ref: '#/components/schemas/crowdstrike_config'
+ - $ref: '#/components/schemas/d3security_config'
+ - $ref: '#/components/schemas/email_config'
+ - $ref: '#/components/schemas/gemini_config'
+ - $ref: '#/components/schemas/resilient_config'
+ - $ref: '#/components/schemas/index_config'
+ - $ref: '#/components/schemas/jira_config'
+ - $ref: '#/components/schemas/genai_azure_config'
+ - $ref: '#/components/schemas/genai_openai_config'
+ - $ref: '#/components/schemas/opsgenie_config'
+ - $ref: '#/components/schemas/pagerduty_config'
+ - $ref: '#/components/schemas/sentinelone_config'
+ - $ref: '#/components/schemas/servicenow_config'
+ - $ref: '#/components/schemas/servicenow_itom_config'
+ - $ref: '#/components/schemas/slack_api_config'
+ - $ref: '#/components/schemas/swimlane_config'
+ - $ref: '#/components/schemas/thehive_config'
+ - $ref: '#/components/schemas/tines_config'
+ - $ref: '#/components/schemas/torq_config'
+ - $ref: '#/components/schemas/webhook_config'
+ - $ref: '#/components/schemas/cases_webhook_config'
+ - $ref: '#/components/schemas/xmatters_config'
secrets:
additionalProperties: {}
default: {}
- type: object
+ oneOf:
+ - $ref: '#/components/schemas/bedrock_secrets'
+ - $ref: '#/components/schemas/crowdstrike_secrets'
+ - $ref: '#/components/schemas/d3security_secrets'
+ - $ref: '#/components/schemas/email_secrets'
+ - $ref: '#/components/schemas/gemini_secrets'
+ - $ref: '#/components/schemas/resilient_secrets'
+ - $ref: '#/components/schemas/jira_secrets'
+ - $ref: '#/components/schemas/teams_secrets'
+ - $ref: '#/components/schemas/genai_secrets'
+ - $ref: '#/components/schemas/opsgenie_secrets'
+ - $ref: '#/components/schemas/pagerduty_secrets'
+ - $ref: '#/components/schemas/sentinelone_secrets'
+ - $ref: '#/components/schemas/servicenow_secrets'
+ - $ref: '#/components/schemas/slack_api_secrets'
+ - $ref: '#/components/schemas/swimlane_secrets'
+ - $ref: '#/components/schemas/thehive_secrets'
+ - $ref: '#/components/schemas/tines_secrets'
+ - $ref: '#/components/schemas/torq_secrets'
+ - $ref: '#/components/schemas/webhook_secrets'
+ - $ref: '#/components/schemas/cases_webhook_secrets'
+ - $ref: '#/components/schemas/xmatters_secrets'
required:
- name
+ examples:
+ updateIndexConnectorRequest:
+ $ref: '#/components/examples/update_index_connector_request'
responses:
'200':
content:
@@ -365,15 +562,10 @@ paths:
description: Indicates whether the connector is missing secrets.
type: boolean
is_preconfigured:
- description: >-
- Indicates whether the connector is preconfigured. If true,
- the `config` and `is_missing_secrets` properties are
- omitted from the response.
+ description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. '
type: boolean
is_system_action:
- description: >-
- Indicates whether the connector is used for system
- actions.
+ description: Indicates whether the connector is used for system actions.
type: boolean
name:
description: ' The name of the rule.'
@@ -391,9 +583,7 @@ paths:
- connectors
/api/actions/connector/{id}/_execute:
post:
- description: >-
- You can use this API to test an action that involves interaction with
- Kibana services or integrations with third-party systems.
+ description: You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.
operationId: post-actions-connector-id-execute
parameters:
- description: The version of the API to use
@@ -426,9 +616,40 @@ paths:
properties:
params:
additionalProperties: {}
- type: object
+ oneOf:
+ - $ref: '#/components/schemas/run_acknowledge_resolve_pagerduty'
+ - $ref: '#/components/schemas/run_documents'
+ - $ref: '#/components/schemas/run_message_email'
+ - $ref: '#/components/schemas/run_message_serverlog'
+ - $ref: '#/components/schemas/run_message_slack'
+ - $ref: '#/components/schemas/run_trigger_pagerduty'
+ - $ref: '#/components/schemas/run_addevent'
+ - $ref: '#/components/schemas/run_closealert'
+ - $ref: '#/components/schemas/run_closeincident'
+ - $ref: '#/components/schemas/run_createalert'
+ - $ref: '#/components/schemas/run_fieldsbyissuetype'
+ - $ref: '#/components/schemas/run_getchoices'
+ - $ref: '#/components/schemas/run_getfields'
+ - $ref: '#/components/schemas/run_getincident'
+ - $ref: '#/components/schemas/run_issue'
+ - $ref: '#/components/schemas/run_issues'
+ - $ref: '#/components/schemas/run_issuetypes'
+ - $ref: '#/components/schemas/run_postmessage'
+ - $ref: '#/components/schemas/run_pushtoservice'
+ - $ref: '#/components/schemas/run_validchannelid'
required:
- params
+ examples:
+ runIndexConnectorRequest:
+ $ref: '#/components/examples/run_index_connector_request'
+ runJiraConnectorRequest:
+ $ref: '#/components/examples/run_jira_connector_request'
+ runServerLogConnectorRequest:
+ $ref: '#/components/examples/run_servicenow_itom_connector_request'
+ runSlackConnectorRequest:
+ $ref: '#/components/examples/run_slack_api_connector_request'
+ runSwimlaneConnectorRequest:
+ $ref: '#/components/examples/run_swimlane_connector_request'
responses:
'200':
content:
@@ -453,15 +674,10 @@ paths:
description: Indicates whether the connector is missing secrets.
type: boolean
is_preconfigured:
- description: >-
- Indicates whether the connector is preconfigured. If true,
- the `config` and `is_missing_secrets` properties are
- omitted from the response.
+ description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. '
type: boolean
is_system_action:
- description: >-
- Indicates whether the connector is used for system
- actions.
+ description: Indicates whether the connector is used for system actions.
type: boolean
name:
description: ' The name of the rule.'
@@ -473,6 +689,19 @@ paths:
- is_preconfigured
- is_deprecated
- is_system_action
+ examples:
+ runIndexConnectorResponse:
+ $ref: '#/components/examples/run_index_connector_response'
+ runJiraConnectorResponse:
+ $ref: '#/components/examples/run_jira_connector_response'
+ runServerLogConnectorResponse:
+ $ref: '#/components/examples/run_server_log_connector_response'
+ runServiceNowITOMConnectorResponse:
+ $ref: '#/components/examples/run_servicenow_itom_connector_response'
+ runSlackConnectorResponse:
+ $ref: '#/components/examples/run_slack_api_connector_response'
+ runSwimlaneConnectorResponse:
+ $ref: '#/components/examples/run_swimlane_connector_response'
description: Indicates a successful call.
summary: Run a connector
tags:
@@ -489,16 +718,21 @@ paths:
enum:
- '2023-10-31'
type: string
- responses: {}
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getConnectorsResponse:
+ $ref: '#/components/examples/get_connectors_response'
summary: Get all connectors
tags:
- connectors
/api/alerting/_health:
get:
- description: >
- You must have `read` privileges for the **Management > Stack Rules**
- feature or for at least one of the **Analytics > Discover**, **Analytics
- > Machine Learning**, **Observability**, or **Security** features.
+ description: |
+ You must have `read` privileges for the **Management > Stack Rules** feature or for at least one of the **Analytics > Discover**, **Analytics > Machine Learning**, **Observability**, or **Security** features.
operationId: getAlertingHealth
responses:
'200':
@@ -511,10 +745,8 @@ paths:
type: object
properties:
alerting_framework_health:
- description: >
- Three substates identify the health of the alerting
- framework: `decryption_health`, `execution_health`, and
- `read_health`.
+ description: |
+ Three substates identify the health of the alerting framework: `decryption_health`, `execution_health`, and `read_health`.
type: object
properties:
decryption_health:
@@ -563,9 +795,7 @@ paths:
format: date-time
type: string
has_permanent_encryption_key:
- description: >-
- If `false`, the encrypted saved object plugin does not
- have a permanent encryption key.
+ description: If `false`, the encrypted saved object plugin does not have a permanent encryption key.
example: true
type: boolean
is_sufficiently_secure:
@@ -584,14 +814,8 @@ paths:
- alerting
/api/alerting/rule_types:
get:
- description: >
- If you have `read` privileges for one or more Kibana features, the API
- response contains information about the appropriate rule types. For
- example, there are rule types associated with the **Management > Stack
- Rules** feature, **Analytics > Discover** and **Machine Learning**
- features, **Observability** features, and **Security** features. To get
- rule types associated with the **Stack Monitoring** feature, use the
- `monitoring_user` built-in role.
+ description: |
+ If you have `read` privileges for one or more Kibana features, the API response contains information about the appropriate rule types. For example, there are rule types associated with the **Management > Stack Rules** feature, **Analytics > Discover** and **Machine Learning** features, **Observability** features, and **Security** features. To get rule types associated with the **Stack Monitoring** feature, use the `monitoring_user` built-in role.
operationId: getRuleTypes
responses:
'200':
@@ -605,11 +829,8 @@ paths:
type: object
properties:
action_groups:
- description: >
- An explicit list of groups for which the rule type can
- schedule actions, each with the action group's unique ID
- and human readable name. Rule actions validation uses
- this configuration to ensure that groups are valid.
+ description: |
+ An explicit list of groups for which the rule type can schedule actions, each with the action group's unique ID and human readable name. Rule actions validation uses this configuration to ensure that groups are valid.
items:
type: object
properties:
@@ -619,13 +840,8 @@ paths:
type: string
type: array
action_variables:
- description: >
- A list of action variables that the rule type makes
- available via context and state in action parameter
- templates, and a short human readable description. When
- you create a rule in Kibana, it uses this information to
- prompt you for these variables in action parameter
- editors.
+ description: |
+ A list of action variables that the rule type makes available via context and state in action parameter templates, and a short human readable description. When you create a rule in Kibana, it uses this information to prompt you for these variables in action parameter editors.
type: object
properties:
context:
@@ -658,9 +874,8 @@ paths:
type: string
type: array
alerts:
- description: >
- Details for writing alerts as data documents for this
- rule type.
+ description: |
+ Details for writing alerts as data documents for this rule type.
type: object
properties:
context:
@@ -686,48 +901,37 @@ paths:
- 'true'
type: string
isSpaceAware:
- description: >
- Indicates whether the alerts are space-aware. If
- true, space-specific alert indices are used.
+ description: |
+ Indicates whether the alerts are space-aware. If true, space-specific alert indices are used.
type: boolean
mappings:
type: object
properties:
fieldMap:
additionalProperties:
- $ref: >-
- #/components/schemas/Alerting_fieldmap_properties
- description: >
- Mapping information for each field supported in
- alerts as data documents for this rule type. For
- more information about mapping parameters, refer
- to the Elasticsearch documentation.
+ $ref: '#/components/schemas/Alerting_fieldmap_properties'
+ description: |
+ Mapping information for each field supported in alerts as data documents for this rule type. For more information about mapping parameters, refer to the Elasticsearch documentation.
type: object
secondaryAlias:
- description: >
- A secondary alias. It is typically used to support
- the signals alias for detection rules.
+ description: |
+ A secondary alias. It is typically used to support the signals alias for detection rules.
type: string
shouldWrite:
- description: >
- Indicates whether the rule should write out alerts
- as data.
+ description: |
+ Indicates whether the rule should write out alerts as data.
type: boolean
useEcs:
- description: >
- Indicates whether to include the ECS component
- template for the alerts.
+ description: |
+ Indicates whether to include the ECS component template for the alerts.
type: boolean
useLegacyAlerts:
default: false
- description: >
- Indicates whether to include the legacy component
- template for the alerts.
+ description: |
+ Indicates whether to include the legacy component template for the alerts.
type: boolean
authorized_consumers:
- description: >-
- The list of the plugins IDs that have access to the rule
- type.
+ description: The list of the plugins IDs that have access to the rule type.
type: object
properties:
alerts:
@@ -808,9 +1012,7 @@ paths:
read:
type: boolean
category:
- description: >-
- The rule category, which is used by features such as
- category-specific maintenance windows.
+ description: The rule category, which is used by features such as category-specific maintenance windows.
enum:
- management
- observability
@@ -820,19 +1022,13 @@ paths:
description: The default identifier for the rule type group.
type: string
does_set_recovery_context:
- description: >-
- Indicates whether the rule passes context variables to
- its recovery action.
+ description: Indicates whether the rule passes context variables to its recovery action.
type: boolean
enabled_in_license:
- description: >-
- Indicates whether the rule type is enabled or disabled
- based on the subscription.
+ description: Indicates whether the rule type is enabled or disabled based on the subscription.
type: boolean
has_alerts_mappings:
- description: >-
- Indicates whether the rule type has custom mappings for
- the alert data.
+ description: Indicates whether the rule type has custom mappings for the alert data.
type: boolean
has_fields_for_a_a_d:
type: boolean
@@ -840,9 +1036,7 @@ paths:
description: The unique identifier for the rule type.
type: string
is_exportable:
- description: >-
- Indicates whether the rule type is exportable in **Stack
- Management > Saved Objects**.
+ description: Indicates whether the rule type is exportable in **Stack Management > Saved Objects**.
type: boolean
minimum_license_required:
description: The subscriptions required to use the rule type.
@@ -852,15 +1046,11 @@ paths:
description: The descriptive name of the rule type.
type: string
producer:
- description: >-
- An identifier for the application that produces this
- rule type.
+ description: An identifier for the application that produces this rule type.
example: stackAlerts
type: string
recovery_action_group:
- description: >-
- An action group to use when an alert goes from an active
- state to an inactive one.
+ description: An action group to use when an alert goes from an active state to an inactive one.
type: object
properties:
id:
@@ -950,9 +1140,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
query:
@@ -960,15 +1148,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL) as defined in
- the `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -978,9 +1161,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -997,9 +1178,7 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
@@ -1009,12 +1188,7 @@ paths:
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the
- days of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -1031,55 +1205,30 @@ paths:
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work
- but lack built-in daylight savings time
- support and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
- hours
- timezone
connector_type_id:
- description: >-
- The type of connector. This property appears in
- responses but cannot be set in requests.
+ description: The type of connector. This property appears in responses but cannot be set in requests.
type: string
frequency:
additionalProperties: false
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -1089,18 +1238,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often
- an alert generates repeated actions. It is
- specified in seconds, minutes, hours, or days
- and is applicable only if 'notify_when' is set
- to 'onThrottleInterval'. NOTE: You cannot
- specify the throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if ''notify_when'' is set to ''onThrottleInterval''. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -1108,30 +1246,20 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
type: string
params:
additionalProperties: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
type: boolean
uuid:
- description: >-
- A universally unique identifier (UUID) for the
- action.
+ description: A universally unique identifier (UUID) for the action.
type: string
required:
- id
@@ -1145,36 +1273,24 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
api_key_created_by_user:
- description: >-
- Indicates whether the API key that is associated with the
- rule was created by the user.
+ description: Indicates whether the API key that is associated with the rule was created by the user.
nullable: true
type: boolean
api_key_owner:
- description: >-
- The owner of the API key that is associated with the rule
- and used to run background tasks.
+ description: The owner of the API key that is associated with the rule and used to run background tasks.
nullable: true
type: string
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
created_at:
description: The date and time that the rule was created.
@@ -1184,9 +1300,7 @@ paths:
nullable: true
type: string
enabled:
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
execution_status:
additionalProperties: false
@@ -1253,14 +1367,17 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -1300,9 +1417,7 @@ paths:
nullable: true
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could be
- succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
@@ -1352,9 +1467,7 @@ paths:
properties:
calculated_metrics:
additionalProperties: false
- description: >-
- Calculation of different percentiles and success
- ratio.
+ description: Calculation of different percentiles and success ratio.
type: object
properties:
p50:
@@ -1377,18 +1490,14 @@ paths:
description: Duration of the rule run.
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could
- be succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
- failed
type: string
success:
- description: >-
- Indicates whether the rule run was
- successful.
+ description: Indicates whether the rule run was successful.
type: boolean
timestamp:
description: Time of rule run.
@@ -1413,29 +1522,19 @@ paths:
nullable: true
type: number
total_alerts_created:
- description: >-
- Total number of alerts created during last
- rule run.
+ description: Total number of alerts created during last rule run.
nullable: true
type: number
total_alerts_detected:
- description: >-
- Total number of alerts detected during
- last rule run.
+ description: Total number of alerts detected during last rule run.
nullable: true
type: number
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during
- last rule run in milliseconds.
+ description: Total time spent indexing documents during last rule run in milliseconds.
nullable: true
type: number
total_search_duration_ms:
- description: >-
- Total time spent performing Elasticsearch
- searches as measured by Kibana; includes
- network latency and time spent serializing
- or deserializing the request and response.
+ description: Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
nullable: true
type: number
timestamp:
@@ -1466,19 +1565,7 @@ paths:
nullable: true
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -1504,9 +1591,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours,
- or days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -1542,9 +1627,7 @@ paths:
type: array
bymonth:
items:
- description: >-
- Indicates months of the year that this rule
- should recur.
+ description: Indicates months of the year that this rule should recur.
type: number
nullable: true
type: array
@@ -1562,12 +1645,7 @@ paths:
type: array
bysetpos:
items:
- description: >-
- A positive or negative integer affecting the
- nth day of the month. For example, -2 combined
- with `byweekday` of FR is 2nd to last Friday
- of the month. It is recommended to not set
- this manually and just use `byweekday`.
+ description: A positive or negative integer affecting the nth day of the month. For example, -2 combined with `byweekday` of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use `byweekday`.
type: number
nullable: true
type: array
@@ -1576,13 +1654,7 @@ paths:
anyOf:
- type: string
- type: number
- description: >-
- Indicates the days of the week to recur or
- else nth-day-of-month strings. For example,
- "+2TU" second Tuesday of month, "-1FR" last
- Friday of the month, which are internally
- converted to a `byweekday/bysetpos`
- combination.
+ description: Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a `byweekday/bysetpos` combination.
nullable: true
type: array
byweekno:
@@ -1593,26 +1665,18 @@ paths:
type: array
byyearday:
items:
- description: >-
- Indicates the days of the year that this rule
- should recur.
+ description: Indicates the days of the year that this rule should recur.
type: number
nullable: true
type: array
count:
- description: >-
- Number of times the rule should recur until it
- stops.
+ description: Number of times the rule should recur until it stops.
type: number
dtstart:
- description: >-
- Rule start date in Coordinated Universal Time
- (UTC).
+ description: Rule start date in Coordinated Universal Time (UTC).
type: string
freq:
- description: >-
- Indicates frequency of the rule. Options are
- YEARLY, MONTHLY, WEEKLY, DAILY.
+ description: Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
enum:
- 0
- 1
@@ -1623,10 +1687,7 @@ paths:
- 6
type: integer
interval:
- description: >-
- Indicates the interval of frequency. For
- example, 1 and YEARLY is every 1 year, 2 and
- WEEKLY is every 2 weeks.
+ description: Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
type: number
tzid:
description: Indicates timezone abbreviation.
@@ -1664,23 +1725,14 @@ paths:
type: array
throttle:
deprecated: true
- description: >-
- Deprecated in 8.13.0. 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.
+ description: 'Deprecated in 8.13.0. 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.'
nullable: true
type: string
updated_at:
description: The date and time that the rule was updated most recently.
type: string
updated_by:
- description: >-
- The identifier for the user that updated this rule most
- recently.
+ description: The identifier for the user that updated this rule most recently.
nullable: true
type: string
view_in_app_relative_url:
@@ -1734,12 +1786,10 @@ paths:
schema:
example: 'true'
type: string
- - description: >-
- The identifier for the rule. If it is omitted, an ID is randomly
- generated.
+ - description: The identifier for the rule. If it is omitted, an ID is randomly generated.
in: path
name: id
- required: false
+ required: true
schema:
type: string
requestBody:
@@ -1758,12 +1808,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Conditions that affect whether the action runs. If you
- specify multiple conditions, all conditions must be
- met for the action to run. For example, if an alert
- occurs within the specified time frame and matches the
- query, the action runs.
+ description: Conditions that affect whether the action runs. If you specify multiple conditions, all conditions must be met for the action to run. For example, if an alert occurs within the specified time frame and matches the query, the action runs.
type: object
properties:
query:
@@ -1771,15 +1816,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query Domain
- Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query Domain
- Specific Language (DSL) as defined in the
- `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -1789,9 +1829,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -1808,27 +1846,18 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
- filters
timeframe:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the days
- of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -1842,32 +1871,20 @@ paths:
type: array
hours:
additionalProperties: false
- description: >-
- Defines the range of time in a day that the
- action can run. If the `start` value is
- `00:00` and the `end` value is `24:00`,
- actions be generated all day.
+ description: Defines the range of time in a day that the action can run. If the `start` value is `00:00` and the `end` value is `24:00`, actions be generated all day.
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work but
- lack built-in daylight savings time support
- and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
@@ -1878,21 +1895,7 @@ paths:
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -1902,17 +1905,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often an
- alert generates repeated actions. It is specified
- in seconds, minutes, hours, or days and is
- applicable only if `notify_when` is set to
- `onThrottleInterval`. NOTE: You cannot specify the
- throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if `notify_when` is set to `onThrottleInterval`. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -1920,12 +1913,7 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
@@ -1933,10 +1921,7 @@ paths:
params:
additionalProperties: {}
default: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
@@ -1949,41 +1934,34 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
enabled:
default: true
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -1991,49 +1969,26 @@ paths:
- look_back_window
- status_change_threshold
name:
- description: >-
- The name of the rule. While this name does not have to be
- unique, a distinctive name can help you identify a rule.
+ description: The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
- onThrottleInterval
nullable: true
type: string
- params:
- additionalProperties: {}
- default: {}
- description: The parameters for the rule.
- type: object
rule_type_id:
description: The rule type identifier.
type: string
schedule:
additionalProperties: false
- description: >-
- The check interval, which specifies how frequently the rule
- conditions are checked.
+ description: The check interval, which specifies how frequently the rule conditions are checked.
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours, or
- days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -2044,20 +1999,44 @@ paths:
type: string
type: array
throttle:
- description: >-
- 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.
+ description: '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.'
nullable: true
type: string
+ params:
+ additionalProperties: {}
+ default: {}
+ description: The parameters for the rule.
+ anyOf:
+ - $ref: '#/components/schemas/params_property_apm_anomaly'
+ - $ref: '#/components/schemas/params_property_apm_error_count'
+ - $ref: '#/components/schemas/params_property_apm_transaction_duration'
+ - $ref: '#/components/schemas/params_property_apm_transaction_error_rate'
+ - $ref: '#/components/schemas/params_es_query_dsl_rule'
+ - $ref: '#/components/schemas/params_es_query_esql_rule'
+ - $ref: '#/components/schemas/params_es_query_kql_rule'
+ - $ref: '#/components/schemas/params_index_threshold_rule'
+ - $ref: '#/components/schemas/params_property_infra_inventory'
+ - $ref: '#/components/schemas/params_property_log_threshold'
+ - $ref: '#/components/schemas/params_property_infra_metric_threshold'
+ - $ref: '#/components/schemas/params_property_slo_burn_rate'
+ - $ref: '#/components/schemas/params_property_synthetics_uptime_tls'
+ - $ref: '#/components/schemas/params_property_synthetics_monitor_status'
required:
- name
- rule_type_id
- consumer
- schedule
+ examples:
+ createEsQueryEsqlRuleRequest:
+ $ref: '#/components/examples/create_es_query_esql_rule_request'
+ createEsQueryRuleRequest:
+ $ref: '#/components/examples/create_es_query_rule_request'
+ createEsQueryKqlRuleRequest:
+ $ref: '#/components/examples/create_es_query_kql_rule_request'
+ createIndexThresholdRuleRequest:
+ $ref: '#/components/examples/create_index_threshold_rule_request'
+ createTrackingContainmentRuleRequest:
+ $ref: '#/components/examples/create_tracking_containment_rule_request'
responses:
'200':
content:
@@ -2073,9 +2052,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
query:
@@ -2083,15 +2060,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL) as defined in
- the `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -2101,9 +2073,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -2120,9 +2090,7 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
@@ -2132,12 +2100,7 @@ paths:
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the
- days of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -2154,55 +2117,30 @@ paths:
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work
- but lack built-in daylight savings time
- support and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
- hours
- timezone
connector_type_id:
- description: >-
- The type of connector. This property appears in
- responses but cannot be set in requests.
+ description: The type of connector. This property appears in responses but cannot be set in requests.
type: string
frequency:
additionalProperties: false
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -2212,18 +2150,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often
- an alert generates repeated actions. It is
- specified in seconds, minutes, hours, or days
- and is applicable only if 'notify_when' is set
- to 'onThrottleInterval'. NOTE: You cannot
- specify the throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if ''notify_when'' is set to ''onThrottleInterval''. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -2231,30 +2158,20 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
type: string
params:
additionalProperties: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
type: boolean
uuid:
- description: >-
- A universally unique identifier (UUID) for the
- action.
+ description: A universally unique identifier (UUID) for the action.
type: string
required:
- id
@@ -2268,36 +2185,24 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
api_key_created_by_user:
- description: >-
- Indicates whether the API key that is associated with the
- rule was created by the user.
+ description: Indicates whether the API key that is associated with the rule was created by the user.
nullable: true
type: boolean
api_key_owner:
- description: >-
- The owner of the API key that is associated with the rule
- and used to run background tasks.
+ description: The owner of the API key that is associated with the rule and used to run background tasks.
nullable: true
type: string
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
created_at:
description: The date and time that the rule was created.
@@ -2307,9 +2212,7 @@ paths:
nullable: true
type: string
enabled:
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
execution_status:
additionalProperties: false
@@ -2376,14 +2279,17 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -2423,9 +2329,7 @@ paths:
nullable: true
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could be
- succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
@@ -2475,9 +2379,7 @@ paths:
properties:
calculated_metrics:
additionalProperties: false
- description: >-
- Calculation of different percentiles and success
- ratio.
+ description: Calculation of different percentiles and success ratio.
type: object
properties:
p50:
@@ -2500,18 +2402,14 @@ paths:
description: Duration of the rule run.
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could
- be succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
- failed
type: string
success:
- description: >-
- Indicates whether the rule run was
- successful.
+ description: Indicates whether the rule run was successful.
type: boolean
timestamp:
description: Time of rule run.
@@ -2536,29 +2434,19 @@ paths:
nullable: true
type: number
total_alerts_created:
- description: >-
- Total number of alerts created during last
- rule run.
+ description: Total number of alerts created during last rule run.
nullable: true
type: number
total_alerts_detected:
- description: >-
- Total number of alerts detected during
- last rule run.
+ description: Total number of alerts detected during last rule run.
nullable: true
type: number
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during
- last rule run in milliseconds.
+ description: Total time spent indexing documents during last rule run in milliseconds.
nullable: true
type: number
total_search_duration_ms:
- description: >-
- Total time spent performing Elasticsearch
- searches as measured by Kibana; includes
- network latency and time spent serializing
- or deserializing the request and response.
+ description: Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
nullable: true
type: number
timestamp:
@@ -2589,19 +2477,7 @@ paths:
nullable: true
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -2627,9 +2503,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours,
- or days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -2665,9 +2539,7 @@ paths:
type: array
bymonth:
items:
- description: >-
- Indicates months of the year that this rule
- should recur.
+ description: Indicates months of the year that this rule should recur.
type: number
nullable: true
type: array
@@ -2685,12 +2557,7 @@ paths:
type: array
bysetpos:
items:
- description: >-
- A positive or negative integer affecting the
- nth day of the month. For example, -2 combined
- with `byweekday` of FR is 2nd to last Friday
- of the month. It is recommended to not set
- this manually and just use `byweekday`.
+ description: A positive or negative integer affecting the nth day of the month. For example, -2 combined with `byweekday` of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use `byweekday`.
type: number
nullable: true
type: array
@@ -2699,13 +2566,7 @@ paths:
anyOf:
- type: string
- type: number
- description: >-
- Indicates the days of the week to recur or
- else nth-day-of-month strings. For example,
- "+2TU" second Tuesday of month, "-1FR" last
- Friday of the month, which are internally
- converted to a `byweekday/bysetpos`
- combination.
+ description: Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a `byweekday/bysetpos` combination.
nullable: true
type: array
byweekno:
@@ -2716,26 +2577,18 @@ paths:
type: array
byyearday:
items:
- description: >-
- Indicates the days of the year that this rule
- should recur.
+ description: Indicates the days of the year that this rule should recur.
type: number
nullable: true
type: array
count:
- description: >-
- Number of times the rule should recur until it
- stops.
+ description: Number of times the rule should recur until it stops.
type: number
dtstart:
- description: >-
- Rule start date in Coordinated Universal Time
- (UTC).
+ description: Rule start date in Coordinated Universal Time (UTC).
type: string
freq:
- description: >-
- Indicates frequency of the rule. Options are
- YEARLY, MONTHLY, WEEKLY, DAILY.
+ description: Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
enum:
- 0
- 1
@@ -2746,10 +2599,7 @@ paths:
- 6
type: integer
interval:
- description: >-
- Indicates the interval of frequency. For
- example, 1 and YEARLY is every 1 year, 2 and
- WEEKLY is every 2 weeks.
+ description: Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
type: number
tzid:
description: Indicates timezone abbreviation.
@@ -2787,23 +2637,14 @@ paths:
type: array
throttle:
deprecated: true
- description: >-
- Deprecated in 8.13.0. 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.
+ description: 'Deprecated in 8.13.0. 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.'
nullable: true
type: string
updated_at:
description: The date and time that the rule was updated most recently.
type: string
updated_by:
- description: >-
- The identifier for the user that updated this rule most
- recently.
+ description: The identifier for the user that updated this rule most recently.
nullable: true
type: string
view_in_app_relative_url:
@@ -2829,6 +2670,17 @@ paths:
- muted_alert_ids
- execution_status
- revision
+ examples:
+ createEsQueryEsqlRuleResponse:
+ $ref: '#/components/examples/create_es_query_esql_rule_response'
+ createEsQueryRuleResponse:
+ $ref: '#/components/examples/create_es_query_rule_response'
+ createEsQueryKqlRuleResponse:
+ $ref: '#/components/examples/create_es_query_kql_rule_response'
+ createIndexThresholdRuleResponse:
+ $ref: '#/components/examples/create_index_threshold_rule_response'
+ createTrackingContainmentRuleResponse:
+ $ref: '#/components/examples/create_tracking_containment_rule_response'
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
@@ -2886,15 +2738,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query Domain
- Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query Domain
- Specific Language (DSL) as defined in the
- `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -2904,9 +2751,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -2923,27 +2768,18 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
- filters
timeframe:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the days
- of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -2957,32 +2793,20 @@ paths:
type: array
hours:
additionalProperties: false
- description: >-
- Defines the range of time in a day that the
- action can run. If the `start` value is
- `00:00` and the `end` value is `24:00`,
- actions be generated all day.
+ description: Defines the range of time in a day that the action can run. If the `start` value is `00:00` and the `end` value is `24:00`, actions be generated all day.
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work but
- lack built-in daylight savings time support
- and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
@@ -2993,21 +2817,7 @@ paths:
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -3017,17 +2827,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often an
- alert generates repeated actions. It is specified
- in seconds, minutes, hours, or days and is
- applicable only if `notify_when` is set to
- `onThrottleInterval`. NOTE: You cannot specify the
- throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if `notify_when` is set to `onThrottleInterval`. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -3035,12 +2835,7 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
@@ -3048,10 +2843,7 @@ paths:
params:
additionalProperties: {}
default: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
@@ -3064,28 +2856,27 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -3093,24 +2884,10 @@ paths:
- look_back_window
- status_change_threshold
name:
- description: >-
- The name of the rule. While this name does not have to be
- unique, a distinctive name can help you identify a rule.
+ description: The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -3127,9 +2904,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours, or
- days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -3140,18 +2915,15 @@ paths:
type: string
type: array
throttle:
- description: >-
- 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.
+ description: '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.'
nullable: true
type: string
required:
- name
- schedule
+ examples:
+ updateRuleRequest:
+ $ref: '#/components/examples/update_rule_request'
responses:
'200':
content:
@@ -3167,9 +2939,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
query:
@@ -3177,15 +2947,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL) as defined in
- the `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -3195,9 +2960,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -3214,9 +2977,7 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
@@ -3226,12 +2987,7 @@ paths:
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the
- days of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -3248,55 +3004,30 @@ paths:
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work
- but lack built-in daylight savings time
- support and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
- hours
- timezone
connector_type_id:
- description: >-
- The type of connector. This property appears in
- responses but cannot be set in requests.
+ description: The type of connector. This property appears in responses but cannot be set in requests.
type: string
frequency:
additionalProperties: false
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -3306,18 +3037,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often
- an alert generates repeated actions. It is
- specified in seconds, minutes, hours, or days
- and is applicable only if 'notify_when' is set
- to 'onThrottleInterval'. NOTE: You cannot
- specify the throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if ''notify_when'' is set to ''onThrottleInterval''. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -3325,30 +3045,20 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
type: string
params:
additionalProperties: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
type: boolean
uuid:
- description: >-
- A universally unique identifier (UUID) for the
- action.
+ description: A universally unique identifier (UUID) for the action.
type: string
required:
- id
@@ -3362,36 +3072,24 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
api_key_created_by_user:
- description: >-
- Indicates whether the API key that is associated with the
- rule was created by the user.
+ description: Indicates whether the API key that is associated with the rule was created by the user.
nullable: true
type: boolean
api_key_owner:
- description: >-
- The owner of the API key that is associated with the rule
- and used to run background tasks.
+ description: The owner of the API key that is associated with the rule and used to run background tasks.
nullable: true
type: string
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
created_at:
description: The date and time that the rule was created.
@@ -3401,9 +3099,7 @@ paths:
nullable: true
type: string
enabled:
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
execution_status:
additionalProperties: false
@@ -3470,14 +3166,17 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -3517,9 +3216,7 @@ paths:
nullable: true
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could be
- succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
@@ -3569,9 +3266,7 @@ paths:
properties:
calculated_metrics:
additionalProperties: false
- description: >-
- Calculation of different percentiles and success
- ratio.
+ description: Calculation of different percentiles and success ratio.
type: object
properties:
p50:
@@ -3594,18 +3289,14 @@ paths:
description: Duration of the rule run.
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could
- be succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
- failed
type: string
success:
- description: >-
- Indicates whether the rule run was
- successful.
+ description: Indicates whether the rule run was successful.
type: boolean
timestamp:
description: Time of rule run.
@@ -3630,29 +3321,19 @@ paths:
nullable: true
type: number
total_alerts_created:
- description: >-
- Total number of alerts created during last
- rule run.
+ description: Total number of alerts created during last rule run.
nullable: true
type: number
total_alerts_detected:
- description: >-
- Total number of alerts detected during
- last rule run.
+ description: Total number of alerts detected during last rule run.
nullable: true
type: number
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during
- last rule run in milliseconds.
+ description: Total time spent indexing documents during last rule run in milliseconds.
nullable: true
type: number
total_search_duration_ms:
- description: >-
- Total time spent performing Elasticsearch
- searches as measured by Kibana; includes
- network latency and time spent serializing
- or deserializing the request and response.
+ description: Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
nullable: true
type: number
timestamp:
@@ -3683,19 +3364,7 @@ paths:
nullable: true
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -3721,9 +3390,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours,
- or days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -3759,9 +3426,7 @@ paths:
type: array
bymonth:
items:
- description: >-
- Indicates months of the year that this rule
- should recur.
+ description: Indicates months of the year that this rule should recur.
type: number
nullable: true
type: array
@@ -3779,12 +3444,7 @@ paths:
type: array
bysetpos:
items:
- description: >-
- A positive or negative integer affecting the
- nth day of the month. For example, -2 combined
- with `byweekday` of FR is 2nd to last Friday
- of the month. It is recommended to not set
- this manually and just use `byweekday`.
+ description: A positive or negative integer affecting the nth day of the month. For example, -2 combined with `byweekday` of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use `byweekday`.
type: number
nullable: true
type: array
@@ -3793,13 +3453,7 @@ paths:
anyOf:
- type: string
- type: number
- description: >-
- Indicates the days of the week to recur or
- else nth-day-of-month strings. For example,
- "+2TU" second Tuesday of month, "-1FR" last
- Friday of the month, which are internally
- converted to a `byweekday/bysetpos`
- combination.
+ description: Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a `byweekday/bysetpos` combination.
nullable: true
type: array
byweekno:
@@ -3810,26 +3464,18 @@ paths:
type: array
byyearday:
items:
- description: >-
- Indicates the days of the year that this rule
- should recur.
+ description: Indicates the days of the year that this rule should recur.
type: number
nullable: true
type: array
count:
- description: >-
- Number of times the rule should recur until it
- stops.
+ description: Number of times the rule should recur until it stops.
type: number
dtstart:
- description: >-
- Rule start date in Coordinated Universal Time
- (UTC).
+ description: Rule start date in Coordinated Universal Time (UTC).
type: string
freq:
- description: >-
- Indicates frequency of the rule. Options are
- YEARLY, MONTHLY, WEEKLY, DAILY.
+ description: Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
enum:
- 0
- 1
@@ -3840,10 +3486,7 @@ paths:
- 6
type: integer
interval:
- description: >-
- Indicates the interval of frequency. For
- example, 1 and YEARLY is every 1 year, 2 and
- WEEKLY is every 2 weeks.
+ description: Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
type: number
tzid:
description: Indicates timezone abbreviation.
@@ -3881,23 +3524,14 @@ paths:
type: array
throttle:
deprecated: true
- description: >-
- Deprecated in 8.13.0. 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.
+ description: 'Deprecated in 8.13.0. 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.'
nullable: true
type: string
updated_at:
description: The date and time that the rule was updated most recently.
type: string
updated_by:
- description: >-
- The identifier for the user that updated this rule most
- recently.
+ description: The identifier for the user that updated this rule most recently.
nullable: true
type: string
view_in_app_relative_url:
@@ -3923,6 +3557,9 @@ paths:
- muted_alert_ids
- execution_status
- revision
+ examples:
+ updateRuleResponse:
+ $ref: '#/components/examples/update_rule_response'
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
@@ -4248,9 +3885,7 @@ paths:
default: 1
minimum: 1
type: number
- - description: >-
- An Elasticsearch simple_query_string query that filters the objects
- in the response.
+ - description: An Elasticsearch simple_query_string query that filters the objects in the response.
in: query
name: search
required: false
@@ -4276,9 +3911,7 @@ paths:
type: string
type: array
- type: string
- - description: >-
- Determines which field is used to sort the results. The field must
- exist in the `attributes` key of the response.
+ - description: Determines which field is used to sort the results. The field must exist in the `attributes` key of the response.
in: query
name: sort_field
required: false
@@ -4293,9 +3926,7 @@ paths:
- asc
- desc
type: string
- - description: >-
- Filters the rules that have a relation with the reference objects
- with a specific type and identifier.
+ - description: Filters the rules that have a relation with the reference objects with a specific type and identifier.
in: query
name: has_reference
required: false
@@ -4319,12 +3950,7 @@ paths:
description: The fields to return in the `attributes` key of the response.
type: string
type: array
- - description: >-
- 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`.
+ - description: '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`.'
in: query
name: filter
required: false
@@ -4353,9 +3979,7 @@ paths:
properties:
alerts_filter:
additionalProperties: false
- description: >-
- Defines a period that limits whether the action
- runs.
+ description: Defines a period that limits whether the action runs.
type: object
properties:
query:
@@ -4363,15 +3987,10 @@ paths:
type: object
properties:
dsl:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL).
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL).
type: string
filters:
- description: >-
- A filter written in Elasticsearch Query
- Domain Specific Language (DSL) as defined in
- the `kbn-es-query` package.
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
items:
additionalProperties: false
type: object
@@ -4381,9 +4000,7 @@ paths:
type: object
properties:
store:
- description: >-
- A filter can be either specific to an
- application context or applied globally.
+ description: A filter can be either specific to an application context or applied globally.
enum:
- appState
- globalState
@@ -4400,9 +4017,7 @@ paths:
- meta
type: array
kql:
- description: >-
- A filter written in Kibana Query Language
- (KQL).
+ description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
@@ -4412,12 +4027,7 @@ paths:
type: object
properties:
days:
- description: >-
- Defines the days of the week that the action
- can run, represented as an array of numbers.
- For example, `1` represents Monday. An empty
- array is equivalent to specifying all the
- days of the week.
+ description: Defines the days of the week that the action can run, represented as an array of numbers. For example, `1` represents Monday. An empty array is equivalent to specifying all the days of the week.
items:
enum:
- 1
@@ -4434,55 +4044,30 @@ paths:
type: object
properties:
end:
- description: >-
- The end of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The end of the time frame in 24-hour notation (`hh:mm`).
type: string
start:
- description: >-
- The start of the time frame in 24-hour
- notation (`hh:mm`).
+ description: The start of the time frame in 24-hour notation (`hh:mm`).
type: string
required:
- start
- end
timezone:
- description: >-
- The ISO time zone for the `hours` values.
- Values such as `UTC` and `UTC+1` also work
- but lack built-in daylight savings time
- support and are not recommended.
+ description: The ISO time zone for the `hours` values. Values such as `UTC` and `UTC+1` also work but lack built-in daylight savings time support and are not recommended.
type: string
required:
- days
- hours
- timezone
connector_type_id:
- description: >-
- The type of connector. This property appears in
- responses but cannot be set in requests.
+ description: The type of connector. This property appears in responses but cannot be set in requests.
type: string
frequency:
additionalProperties: false
type: object
properties:
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -4492,18 +4077,7 @@ paths:
description: Indicates whether the action is a summary.
type: boolean
throttle:
- description: >-
- The throttle interval, which defines how often
- an alert generates repeated actions. It is
- specified in seconds, minutes, hours, or days
- and is applicable only if 'notify_when' is set
- to 'onThrottleInterval'. NOTE: You cannot
- specify the throttle interval 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.
+ description: 'The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if ''notify_when'' is set to ''onThrottleInterval''. NOTE: You cannot specify the throttle interval 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.'
nullable: true
type: string
required:
@@ -4511,30 +4085,20 @@ paths:
- notify_when
- throttle
group:
- description: >-
- The group name, which affects when the action runs
- (for example, when the threshold is met or when the
- alert is recovered). Each rule type has a list of
- valid action group names. If you don't need to group
- actions, set to `default`.
+ description: The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to `default`.
type: string
id:
description: The identifier for the connector saved object.
type: string
params:
additionalProperties: {}
- description: >-
- The parameters for the action, which are sent to the
- connector. The `params` are handled as Mustache
- templates and passed a default set of context.
+ description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
type: object
use_alert_data_for_template:
description: Indicates whether to use alert data as a template.
type: boolean
uuid:
- description: >-
- A universally unique identifier (UUID) for the
- action.
+ description: A universally unique identifier (UUID) for the action.
type: string
required:
- id
@@ -4548,36 +4112,24 @@ paths:
type: array
alert_delay:
additionalProperties: false
- description: >-
- Indicates that an alert occurs only when the specified
- number of consecutive runs met the rule conditions.
+ description: Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
type: object
properties:
active:
- description: >-
- The number of consecutive runs that must meet the rule
- conditions.
+ description: The number of consecutive runs that must meet the rule conditions.
type: number
required:
- active
api_key_created_by_user:
- description: >-
- Indicates whether the API key that is associated with the
- rule was created by the user.
+ description: Indicates whether the API key that is associated with the rule was created by the user.
nullable: true
type: boolean
api_key_owner:
- description: >-
- The owner of the API key that is associated with the rule
- and used to run background tasks.
+ description: The owner of the API key that is associated with the rule and used to run background tasks.
nullable: true
type: string
consumer:
- description: >-
- 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`.
+ description: '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`.'
type: string
created_at:
description: The date and time that the rule was created.
@@ -4587,9 +4139,7 @@ paths:
nullable: true
type: string
enabled:
- description: >-
- Indicates whether you want to run the rule on an interval
- basis after it is created.
+ description: Indicates whether you want to run the rule on an interval basis after it is created.
type: boolean
execution_status:
additionalProperties: false
@@ -4656,14 +4206,17 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
+ description: When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
+ description: The minimum number of runs in which the threshold must be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
+ description: The minimum number of times an alert must switch states in the look back window.
maximum: 20
minimum: 2
type: number
@@ -4703,9 +4256,7 @@ paths:
nullable: true
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could be
- succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
@@ -4755,9 +4306,7 @@ paths:
properties:
calculated_metrics:
additionalProperties: false
- description: >-
- Calculation of different percentiles and success
- ratio.
+ description: Calculation of different percentiles and success ratio.
type: object
properties:
p50:
@@ -4780,18 +4329,14 @@ paths:
description: Duration of the rule run.
type: number
outcome:
- description: >-
- Outcome of last run of the rule. Value could
- be succeeded, warning or failed.
+ description: Outcome of last run of the rule. Value could be succeeded, warning or failed.
enum:
- succeeded
- warning
- failed
type: string
success:
- description: >-
- Indicates whether the rule run was
- successful.
+ description: Indicates whether the rule run was successful.
type: boolean
timestamp:
description: Time of rule run.
@@ -4816,29 +4361,19 @@ paths:
nullable: true
type: number
total_alerts_created:
- description: >-
- Total number of alerts created during last
- rule run.
+ description: Total number of alerts created during last rule run.
nullable: true
type: number
total_alerts_detected:
- description: >-
- Total number of alerts detected during
- last rule run.
+ description: Total number of alerts detected during last rule run.
nullable: true
type: number
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during
- last rule run in milliseconds.
+ description: Total time spent indexing documents during last rule run in milliseconds.
nullable: true
type: number
total_search_duration_ms:
- description: >-
- Total time spent performing Elasticsearch
- searches as measured by Kibana; includes
- network latency and time spent serializing
- or deserializing the request and response.
+ description: Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
nullable: true
type: number
timestamp:
@@ -4869,19 +4404,7 @@ paths:
nullable: true
type: string
notify_when:
- description: >-
- 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.
+ description: '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.'
enum:
- onActionGroupChange
- onActiveAlert
@@ -4907,9 +4430,7 @@ paths:
type: object
properties:
interval:
- description: >-
- The interval is specified in seconds, minutes, hours,
- or days.
+ description: The interval is specified in seconds, minutes, hours, or days.
type: string
required:
- interval
@@ -4945,9 +4466,7 @@ paths:
type: array
bymonth:
items:
- description: >-
- Indicates months of the year that this rule
- should recur.
+ description: Indicates months of the year that this rule should recur.
type: number
nullable: true
type: array
@@ -4965,12 +4484,7 @@ paths:
type: array
bysetpos:
items:
- description: >-
- A positive or negative integer affecting the
- nth day of the month. For example, -2 combined
- with `byweekday` of FR is 2nd to last Friday
- of the month. It is recommended to not set
- this manually and just use `byweekday`.
+ description: A positive or negative integer affecting the nth day of the month. For example, -2 combined with `byweekday` of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use `byweekday`.
type: number
nullable: true
type: array
@@ -4979,13 +4493,7 @@ paths:
anyOf:
- type: string
- type: number
- description: >-
- Indicates the days of the week to recur or
- else nth-day-of-month strings. For example,
- "+2TU" second Tuesday of month, "-1FR" last
- Friday of the month, which are internally
- converted to a `byweekday/bysetpos`
- combination.
+ description: Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a `byweekday/bysetpos` combination.
nullable: true
type: array
byweekno:
@@ -4996,26 +4504,18 @@ paths:
type: array
byyearday:
items:
- description: >-
- Indicates the days of the year that this rule
- should recur.
+ description: Indicates the days of the year that this rule should recur.
type: number
nullable: true
type: array
count:
- description: >-
- Number of times the rule should recur until it
- stops.
+ description: Number of times the rule should recur until it stops.
type: number
dtstart:
- description: >-
- Rule start date in Coordinated Universal Time
- (UTC).
+ description: Rule start date in Coordinated Universal Time (UTC).
type: string
freq:
- description: >-
- Indicates frequency of the rule. Options are
- YEARLY, MONTHLY, WEEKLY, DAILY.
+ description: Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
enum:
- 0
- 1
@@ -5026,10 +4526,7 @@ paths:
- 6
type: integer
interval:
- description: >-
- Indicates the interval of frequency. For
- example, 1 and YEARLY is every 1 year, 2 and
- WEEKLY is every 2 weeks.
+ description: Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
type: number
tzid:
description: Indicates timezone abbreviation.
@@ -5067,23 +4564,14 @@ paths:
type: array
throttle:
deprecated: true
- description: >-
- Deprecated in 8.13.0. 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.
+ description: 'Deprecated in 8.13.0. 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.'
nullable: true
type: string
updated_at:
description: The date and time that the rule was updated most recently.
type: string
updated_by:
- description: >-
- The identifier for the user that updated this rule most
- recently.
+ description: The identifier for the user that updated this rule most recently.
nullable: true
type: string
view_in_app_relative_url:
@@ -5109,6 +4597,11 @@ paths:
- muted_alert_ids
- execution_status
- revision
+ examples:
+ findRulesResponse:
+ $ref: '#/components/examples/find_rules_response'
+ findConditionalActionRulesResponse:
+ $ref: '#/components/examples/find_rules_response_conditional_action'
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
@@ -5120,9 +4613,8 @@ paths:
/api/alerts/alert/{alertId}:
delete:
deprecated: true
- description: >
- Deprecated in 7.13.0. Use the delete rule API instead. WARNING: After
- you delete an alert, you cannot recover it.
+ description: |
+ Deprecated in 7.13.0. Use the delete rule API instead. WARNING: After you delete an alert, you cannot recover it.
operationId: legaryDeleteAlert
parameters:
- $ref: '#/components/parameters/Alerting_kbn_xsrf'
@@ -5179,9 +4671,7 @@ paths:
operationId: legacyCreateAlert
parameters:
- $ref: '#/components/parameters/Alerting_kbn_xsrf'
- - description: >-
- An UUID v1 or v4 identifier for the alert. If this parameter is
- omitted, the identifier is randomly generated.
+ - description: An UUID v1 or v4 identifier for the alert. If this parameter is omitted, the identifier is randomly generated.
in: path
name: alertId
required: true
@@ -5203,19 +4693,15 @@ paths:
description: The identifier for the action type.
type: string
group:
- description: >
- Grouping actions is recommended for escalations for
- different types of alert instances. If you don't need
- this functionality, set it to `default`.
+ description: |
+ Grouping actions is recommended for escalations for different types of alert instances. If you don't need this functionality, set it to `default`.
type: string
id:
description: The ID of the action saved object.
type: string
params:
- description: >
- The map to the `params` that the action type will
- receive. `params` are handled as Mustache templates
- and passed a default set of context.
+ description: |
+ The map to the `params` that the action type will receive. `params` are handled as Mustache templates and passed a default set of context.
type: object
required:
- actionTypeId
@@ -5224,20 +4710,13 @@ paths:
- params
type: array
alertTypeId:
- description: >-
- The ID of the alert type that you want to call when the
- alert is scheduled to run.
+ description: The ID of the alert type that you want to call when the alert is scheduled to run.
type: string
consumer:
- description: >-
- The name of the application that owns the alert. This name
- has to match the Kibana feature name, as that dictates the
- required role-based access control privileges.
+ description: The name of the application that owns the alert. This name has to match the Kibana feature name, as that dictates the required role-based access control privileges.
type: string
enabled:
- description: >-
- Indicates if you want to run the alert on an interval basis
- after it is created.
+ description: Indicates if you want to run the alert on an interval basis after it is created.
type: boolean
name:
description: A name to reference and search.
@@ -5250,22 +4729,15 @@ paths:
- onThrottleInterval
type: string
params:
- description: >-
- The parameters to pass to the alert type executor `params`
- value. This will also validate against the alert type params
- validator, if defined.
+ description: The parameters to pass to the alert type executor `params` value. This will also validate against the alert type params validator, if defined.
type: object
schedule:
- description: >
- The schedule specifying when this alert should be run. A
- schedule is structured such that the key specifies the
- format you wish to use and its value specifies the schedule.
+ description: |
+ The schedule specifying when this alert should be run. A schedule is structured such that the key specifies the format you wish to use and its value specifies the schedule.
type: object
properties:
interval:
- description: >-
- The interval format specifies the interval in seconds,
- minutes, hours or days at which the alert should run.
+ description: The interval format specifies the interval in seconds, minutes, hours or days at which the alert should run.
example: 10s
type: string
tags:
@@ -5274,13 +4746,8 @@ paths:
type: string
type: array
throttle:
- description: >
- How often this alert should fire the same actions. This will
- prevent the alert from sending out the same notification
- over and over. For example, if an alert with a schedule of 1
- minute stays in a triggered state for 90 minutes, setting a
- throttle of `10m` or `1h` will prevent it from sending 90
- notifications during this period.
+ description: |
+ How often this alert should fire the same actions. This will prevent the alert from sending out the same notification over and over. For example, if an alert with a schedule of 1 minute stays in a triggered state for 90 minutes, setting a throttle of `10m` or `1h` will prevent it from sending 90 notifications during this period.
type: string
required:
- alertTypeId
@@ -5334,19 +4801,15 @@ paths:
description: The identifier for the action type.
type: string
group:
- description: >
- Grouping actions is recommended for escalations for
- different types of alert instances. If you don't need
- this functionality, set it to `default`.
+ description: |
+ Grouping actions is recommended for escalations for different types of alert instances. If you don't need this functionality, set it to `default`.
type: string
id:
description: The ID of the action saved object.
type: string
params:
- description: >
- The map to the `params` that the action type will
- receive. `params` are handled as Mustache templates
- and passed a default set of context.
+ description: |
+ The map to the `params` that the action type will receive. `params` are handled as Mustache templates and passed a default set of context.
type: object
required:
- actionTypeId
@@ -5365,22 +4828,15 @@ paths:
- onThrottleInterval
type: string
params:
- description: >-
- The parameters to pass to the alert type executor `params`
- value. This will also validate against the alert type params
- validator, if defined.
+ description: The parameters to pass to the alert type executor `params` value. This will also validate against the alert type params validator, if defined.
type: object
schedule:
- description: >
- The schedule specifying when this alert should be run. A
- schedule is structured such that the key specifies the
- format you wish to use and its value specifies the schedule.
+ description: |
+ The schedule specifying when this alert should be run. A schedule is structured such that the key specifies the format you wish to use and its value specifies the schedule.
type: object
properties:
interval:
- description: >-
- The interval format specifies the interval in seconds,
- minutes, hours or days at which the alert should run.
+ description: The interval format specifies the interval in seconds, minutes, hours or days at which the alert should run.
example: 1d
type: string
tags:
@@ -5389,13 +4845,8 @@ paths:
type: string
type: array
throttle:
- description: >
- How often this alert should fire the same actions. This will
- prevent the alert from sending out the same notification
- over and over. For example, if an alert with a schedule of 1
- minute stays in a triggered state for 90 minutes, setting a
- throttle of `10m` or `1h` will prevent it from sending 90
- notifications during this period.
+ description: |
+ How often this alert should fire the same actions. This will prevent the alert from sending out the same notification over and over. For example, if an alert with a schedule of 1 minute stays in a triggered state for 90 minutes, setting a throttle of `10m` or `1h` will prevent it from sending 90 notifications during this period.
type: string
required:
- name
@@ -5592,12 +5043,8 @@ paths:
/api/alerts/alerts/_find:
get:
deprecated: true
- description: >
- Deprecated in 7.13.0. Use the find rules API instead. NOTE: Alert
- `params` are stored as a flattened field type and analyzed as keywords.
- As alerts change in Kibana, the results on each page of the response
- also change. Use the find API for traditional paginated results, but
- avoid using it to export large amounts of data.
+ description: |
+ Deprecated in 7.13.0. Use the find rules API instead. NOTE: Alert `params` are stored as a flattened field type and analyzed as keywords. As alerts change in Kibana, the results on each page of the response also change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.
operationId: legacyFindAlerts
parameters:
- description: The default operator to use for the `simple_query_string`.
@@ -5614,19 +5061,13 @@ paths:
items:
type: string
type: array
- - description: >
- 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`.
+ - description: |
+ 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`.
in: query
name: filter
schema:
type: string
- - description: >-
- Filters the rules that have a relation with the reference objects
- with a specific type and identifier.
+ - description: Filters the rules that have a relation with the reference objects with a specific type and identifier.
in: query
name: has_reference
schema:
@@ -5650,16 +5091,12 @@ paths:
schema:
default: 20
type: integer
- - description: >-
- An Elasticsearch `simple_query_string` query that filters the alerts
- in the response.
+ - description: An Elasticsearch `simple_query_string` query that filters the alerts in the response.
in: query
name: search
schema:
type: string
- - description: >-
- The fields to perform the `simple_query_string` parsed query
- against.
+ - description: The fields to perform the `simple_query_string` parsed query against.
in: query
name: search_fields
schema:
@@ -5668,9 +5105,8 @@ paths:
- items:
type: string
type: array
- - description: >
- Determines which field is used to sort the results. The field must
- exist in the `attributes` key of the response.
+ - description: |
+ Determines which field is used to sort the results. The field must exist in the `attributes` key of the response.
in: query
name: sort_field
schema:
@@ -5725,10 +5161,8 @@ paths:
type: object
properties:
alertingFrameworkHealth:
- description: >
- Three substates identify the health of the alerting
- framework: `decryptionHealth`, `executionHealth`, and
- `readHealth`.
+ description: |
+ Three substates identify the health of the alerting framework: `decryptionHealth`, `executionHealth`, and `readHealth`.
type: object
properties:
decryptionHealth:
@@ -5777,9 +5211,7 @@ paths:
format: date-time
type: string
hasPermanentEncryptionKey:
- description: >-
- If `false`, the encrypted saved object plugin does not
- have a permanent encryption key.
+ description: If `false`, the encrypted saved object plugin does not have a permanent encryption key.
example: true
type: boolean
isSufficientlySecure:
@@ -5810,11 +5242,8 @@ paths:
type: object
properties:
actionGroups:
- description: >
- An explicit list of groups for which the alert type can
- schedule actions, each with the action group's unique ID
- and human readable name. Alert actions validation uses
- this configuration to ensure that groups are valid.
+ description: |
+ An explicit list of groups for which the alert type can schedule actions, each with the action group's unique ID and human readable name. Alert actions validation uses this configuration to ensure that groups are valid.
items:
type: object
properties:
@@ -5824,12 +5253,8 @@ paths:
type: string
type: array
actionVariables:
- description: >
- A list of action variables that the alert type makes
- available via context and state in action parameter
- templates, and a short human readable description. The
- Alert UI will use this information to prompt users for
- these variables in action parameter editors.
+ description: |
+ A list of action variables that the alert type makes available via context and state in action parameter templates, and a short human readable description. The Alert UI will use this information to prompt users for these variables in action parameter editors.
type: object
properties:
context:
@@ -5860,25 +5285,19 @@ paths:
type: string
type: array
authorizedConsumers:
- description: >-
- The list of the plugins IDs that have access to the
- alert type.
+ description: The list of the plugins IDs that have access to the alert type.
type: object
defaultActionGroupId:
description: The default identifier for the alert type group.
type: string
enabledInLicense:
- description: >-
- Indicates whether the rule type is enabled based on the
- subscription.
+ description: Indicates whether the rule type is enabled based on the subscription.
type: boolean
id:
description: The unique identifier for the alert type.
type: string
isExportable:
- description: >-
- Indicates whether the alert type is exportable in Saved
- Objects Management UI.
+ description: Indicates whether the alert type is exportable in Saved Objects Management UI.
type: boolean
minimumLicenseRequired:
description: The subscriptions required to use the alert type.
@@ -5887,15 +5306,11 @@ paths:
description: The descriptive name of the alert type.
type: string
producer:
- description: >-
- An identifier for the application that produces this
- alert type.
+ description: An identifier for the application that produces this alert type.
type: string
recoveryActionGroup:
- description: >
- An action group to use when an alert instance goes from
- an active state to an inactive one. If it is not
- specified, the default recovered action group is used.
+ description: |
+ An action group to use when an alert instance goes from an active state to an inactive one. If it is not specified, the default recovered action group is used.
type: object
properties:
id:
@@ -6142,8 +5557,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/APM_UI_delete_agent_configurations_response
+ $ref: '#/components/schemas/APM_UI_delete_agent_configurations_response'
description: Successful response
'400':
content:
@@ -6336,9 +5750,8 @@ paths:
- APM agent configuration
/api/apm/settings/agent-configuration/search:
post:
- description: >
- This endpoint allows to search for single agent configuration and update
- 'applied_by_agent' field.
+ description: |
+ This endpoint allows to search for single agent configuration and update 'applied_by_agent' field.
operationId: searchSingleConfiguration
parameters:
- $ref: '#/components/parameters/APM_UI_elastic_api_version'
@@ -6354,8 +5767,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/APM_UI_search_agent_configuration_response
+ $ref: '#/components/schemas/APM_UI_search_agent_configuration_response'
description: Successful response
'400':
content:
@@ -6400,8 +5812,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/APM_UI_single_agent_configuration_response
+ $ref: '#/components/schemas/APM_UI_single_agent_configuration_response'
description: Successful response
'400':
content:
@@ -6614,13 +6025,10 @@ paths:
type: object
properties:
deleted:
- description: >-
- True if the record was deleted or false if the record did
- not exist.
+ description: True if the record was deleted or false if the record did not exist.
type: boolean
record:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord'
description: The deleted record if it existed.
required:
- deleted
@@ -6652,8 +6060,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord'
description: Successful response
'400':
description: Invalid request
@@ -6663,27 +6070,21 @@ paths:
tags:
- Security Entity Analytics API
post:
- description: >
+ description: |
Create or update an asset criticality record for a specific entity.
-
- If a record already exists for the specified entity, that record is
- overwritten with the specified value. If a record doesn't exist for the
- specified entity, a new record is created.
+ If a record already exists for the specified entity, that record is overwritten with the specified value. If a record doesn't exist for the specified entity, a new record is created.
operationId: CreateAssetCriticalityRecord
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
allOf:
- - $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord
+ - $ref: '#/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord'
- type: object
properties:
refresh:
- description: >-
- If 'wait_for' the request will wait for the index
- refresh.
+ description: If 'wait_for' the request will wait for the index refresh.
enum:
- wait_for
type: string
@@ -6693,8 +6094,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord'
description: Successful response
'400':
description: Invalid request
@@ -6703,14 +6103,10 @@ paths:
- Security Entity Analytics API
/api/asset_criticality/bulk:
post:
- description: >
+ description: |
Bulk upsert up to 1000 asset criticality records.
-
- If asset criticality records already exist for the specified entities,
- those records are overwritten with the specified values. If asset
- criticality records don't exist for the specified entities, new records
- are created.
+ If asset criticality records already exist for the specified entities, those records are overwritten with the specified values. If asset criticality records don't exist for the specified entities, new records are created.
operationId: BulkUpsertAssetCriticalityRecords
requestBody:
content:
@@ -6728,8 +6124,7 @@ paths:
properties:
records:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord'
maxItems: 1000
minItems: 1
type: array
@@ -6752,12 +6147,10 @@ paths:
properties:
errors:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityBulkUploadErrorItem
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityBulkUploadErrorItem'
type: array
stats:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityBulkUploadStats
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityBulkUploadStats'
required:
- errors
- stats
@@ -6829,8 +6222,7 @@ paths:
type: integer
records:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecord'
type: array
total:
minimum: 0
@@ -6846,11 +6238,8 @@ paths:
- Security Entity Analytics API
/api/cases:
delete:
- description: >
- You must have `read` or `all` privileges and the `delete` sub-feature
- privilege for the **Cases** feature in the **Management**,
- **Observability**, or **Security** section of the Kibana feature
- privileges, depending on the owner of the cases you're deleting.
+ description: |
+ You must have `read` or `all` privileges and the `delete` sub-feature privilege for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.
operationId: deleteCaseDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -6868,11 +6257,8 @@ paths:
tags:
- cases
patch:
- description: >
- You must have `all` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the
- Kibana feature privileges, depending on the owner of the case you're
- updating.
+ description: |
+ You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating.
operationId: updateCaseDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -6906,11 +6292,8 @@ paths:
tags:
- cases
post:
- description: >
- You must have `all` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the
- Kibana feature privileges, depending on the owner of the case you're
- creating.
+ description: |
+ You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.
operationId: createCaseDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -6944,10 +6327,8 @@ paths:
- cases
/api/cases/_find:
get:
- description: >
- You must have `read` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the cases you're seeking.
+ description: |
+ You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.
operationId: findCasesDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_assignees_filter'
@@ -7005,10 +6386,8 @@ paths:
- cases
/api/cases/{caseId}:
get:
- description: >
- You must have `read` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the case you're seeking.
+ description: |
+ You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're seeking.
operationId: getCaseDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_case_id'
@@ -7036,10 +6415,8 @@ paths:
- cases
/api/cases/{caseId}/alerts:
get:
- description: >
- You must have `read` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the cases you're seeking.
+ description: |
+ You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.
operationId: getCaseAlertsDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_case_id'
@@ -7067,11 +6444,8 @@ paths:
x-state: Technical preview
/api/cases/{caseId}/comments:
delete:
- description: >
- Deletes all comments and alerts from a case. You must have `all`
- privileges for the **Cases** feature in the **Management**,
- **Observability**, or **Security** section of the Kibana feature
- privileges, depending on the owner of the cases you're deleting.
+ description: |
+ Deletes all comments and alerts from a case. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.
operationId: deleteCaseCommentsDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -7090,13 +6464,8 @@ paths:
- cases
get:
deprecated: true
- description: >
- Deprecated in 8.1.0. This API is deprecated and will be removed in a
- future release; instead, use the get case comment API, which requires a
- comment identifier in the path. You must have `read` privileges for the
- **Cases** feature in the **Management**, **Observability**, or
- **Security** section of the Kibana feature privileges, depending on the
- owner of the cases with the comments you're seeking.
+ description: |
+ Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; instead, use the get case comment API, which requires a comment identifier in the path. You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.
operationId: getAllCaseCommentsDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_case_id'
@@ -7117,11 +6486,8 @@ paths:
tags:
- cases
patch:
- description: >
- You must have `all` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the case you're updating.
- NOTE: You cannot change the comment type or the owner of a comment.
+ description: |
+ You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating. NOTE: You cannot change the comment type or the owner of a comment.
operationId: updateCaseCommentDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -7155,11 +6521,8 @@ paths:
tags:
- cases
post:
- description: >
- You must have `all` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the case you're creating.
- NOTE: Each case can have a maximum of 1,000 alerts.
+ description: |
+ You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating. NOTE: Each case can have a maximum of 1,000 alerts.
operationId: addCaseCommentDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -7194,12 +6557,8 @@ paths:
- cases
/api/cases/{caseId}/comments/_find:
get:
- description: >
- Retrieves a paginated list of comments for a case. You must have `read`
- privileges for the **Cases** feature in the **Management**,
- **Observability**, or **Security** section of the Kibana feature
- privileges, depending on the owner of the cases with the comments you're
- seeking.
+ description: |
+ Retrieves a paginated list of comments for a case. You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.
operationId: findCaseCommentsDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_case_id'
@@ -7224,10 +6583,8 @@ paths:
- cases
/api/cases/{caseId}/comments/{commentId}:
delete:
- description: >
- You must have `all` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the cases you're deleting.
+ description: |
+ You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.
operationId: deleteCaseCommentDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -7246,11 +6603,8 @@ paths:
tags:
- cases
get:
- description: >
- You must have `read` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the cases with the
- comments you're seeking.
+ description: |
+ You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.
operationId: getCaseCommentDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_case_id'
@@ -7264,10 +6618,8 @@ paths:
$ref: '#/components/examples/Cases_get_comment_response'
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Cases_alert_comment_response_properties
- - $ref: >-
- #/components/schemas/Cases_user_comment_response_properties
+ - $ref: '#/components/schemas/Cases_alert_comment_response_properties'
+ - $ref: '#/components/schemas/Cases_user_comment_response_properties'
description: Indicates a successful call.
'401':
content:
@@ -7280,12 +6632,8 @@ paths:
- cases
/api/cases/{caseId}/connector/{connectorId}/_push:
post:
- description: >
- You must have `all` privileges for the **Actions and Connectors**
- feature in the **Management** section of the Kibana feature privileges.
- You must also have `all` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the case you're pushing.
+ description: |
+ You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. You must also have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're pushing.
operationId: pushCaseDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_case_id'
@@ -7316,16 +6664,46 @@ paths:
summary: Push a case to an external service
tags:
- cases
+ /api/cases/{caseId}/files:
+ post:
+ description: |
+ Attach a file to a case. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating. The request must include:
+ - The `Content-Type: multipart/form-data` HTTP header.
+ - The location of the file that is being uploaded.
+ operationId: addCaseFileDefaultSpace
+ parameters:
+ - $ref: '#/components/parameters/Cases_kbn_xsrf'
+ - $ref: '#/components/parameters/Cases_case_id'
+ requestBody:
+ content:
+ multipart/form-data; Elastic-Api-Version=2023-10-31:
+ schema:
+ $ref: '#/components/schemas/Cases_add_case_file_request'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ addCaseFileResponse:
+ $ref: '#/components/examples/Cases_add_comment_response'
+ schema:
+ $ref: '#/components/schemas/Cases_case_response_properties'
+ description: Indicates a successful call.
+ '401':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ schema:
+ $ref: '#/components/schemas/Cases_4xx_response'
+ description: Authorization information is missing or invalid.
+ summary: Attach a file to a case
+ tags:
+ - cases
/api/cases/{caseId}/user_actions:
get:
deprecated: true
- description: >
- Returns all user activity for a case. Deprecated in 8.1.0. This API is
- deprecated and will be removed in a future release; use the find user
- actions API instead. You must have `read` privileges for the **Cases**
- feature in the **Management**, **Observability**, or **Security**
- section of the Kibana feature privileges, depending on the owner of the
- case you're seeking.
+ description: |
+ Returns all user activity for a case. Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find user actions API instead. You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're seeking.
operationId: getCaseActivityDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_case_id'
@@ -7349,11 +6727,8 @@ paths:
- cases
/api/cases/{caseId}/user_actions/_find:
get:
- description: >
- Retrives a paginated list of user activity for a case. You must have
- `read` privileges for the **Cases** feature in the **Management**,
- **Observability**, or **Security** section of the Kibana feature
- privileges, depending on the owner of the case you're seeking.
+ description: |
+ Retrives a paginated list of user activity for a case. You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're seeking.
operationId: findCaseActivityDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_case_id'
@@ -7379,8 +6754,7 @@ paths:
type: integer
userActions:
items:
- $ref: >-
- #/components/schemas/Cases_user_actions_find_response_properties
+ $ref: '#/components/schemas/Cases_user_actions_find_response_properties'
maxItems: 10000
type: array
description: Indicates a successful call.
@@ -7395,10 +6769,8 @@ paths:
- cases
/api/cases/alerts/{alertId}:
get:
- description: >
- You must have `read` privileges for the **Cases** feature in the
- **Management**, **Observability**, or **Security** section of the Kibana
- feature privileges, depending on the owner of the cases you're seeking.
+ description: |
+ You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.
operationId: getCasesByAlertDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_alert_id'
@@ -7435,12 +6807,8 @@ paths:
x-state: Technical preview
/api/cases/configure:
get:
- description: >
- Get setting details such as the closure type, custom fields, templatse,
- and the default connector for cases. You must have `read` privileges for
- the **Cases** feature in the **Management**, **Observability**, or
- **Security** section of the Kibana feature privileges, depending on
- where the cases were created.
+ description: |
+ Get setting details such as the closure type, custom fields, templatse, and the default connector for cases. You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where the cases were created.
operationId: getCaseConfigurationDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner_filter'
@@ -7461,24 +6829,15 @@ paths:
type: object
properties:
fields:
- description: >-
- The fields specified in the case configuration are
- not used and are not propagated to individual cases,
- therefore it is recommended to set it to `null`.
+ description: The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to `null`.
nullable: true
type: object
id:
- description: >-
- The identifier for the connector. If you do not want
- a default connector, use `none`. To retrieve
- connector IDs, use the find connectors API.
+ description: The identifier for the connector. If you do not want a default connector, use `none`. To retrieve connector IDs, use the find connectors API.
example: none
type: string
name:
- description: >-
- The name of the connector. If you do not want a
- default connector, use `none`. To retrieve connector
- names, use the find connectors API.
+ description: The name of the connector. If you do not want a default connector, use `none`. To retrieve connector names, use the find connectors API.
example: none
type: string
type:
@@ -7515,27 +6874,19 @@ paths:
type: object
properties:
defaultValue:
- description: >
- A default value for the custom field. If the
- `type` is `text`, the default value must be a
- string. If the `type` is `toggle`, the default
- value must be boolean.
+ description: |
+ A default value for the custom field. If the `type` is `text`, the default value must be a string. If the `type` is `toggle`, the default value must be boolean.
oneOf:
- type: string
- type: boolean
key:
- description: >
- A unique key for the custom field. Must be lower
- case and composed only of a-z, 0-9, '_', and '-'
- characters. It is used in API calls to refer to a
- specific custom field.
+ description: |
+ A unique key for the custom field. Must be lower case and composed only of a-z, 0-9, '_', and '-' characters. It is used in API calls to refer to a specific custom field.
maxLength: 36
minLength: 1
type: string
label:
- description: >-
- The custom field label that is displayed in the
- case.
+ description: The custom field label that is displayed in the case.
maxLength: 50
minLength: 1
type: string
@@ -7546,10 +6897,8 @@ paths:
- toggle
type: string
required:
- description: >
- Indicates whether the field is required. If
- `false`, the custom field can be set to null or
- omitted when a case is created or updated.
+ description: |
+ Indicates whether the field is required. If `false`, the custom field can be set to null or omitted when a case is created or updated.
type: boolean
type: array
error:
@@ -7620,16 +6969,8 @@ paths:
tags:
- cases
post:
- description: >
- Case settings include external connection details, custom fields, and
- templates. Connectors are used to interface with external systems. You
- must create a connector before you can use it in your cases. If you set
- a default connector, it is automatically selected when you create cases
- in Kibana. If you use the create case API, however, you must still
- specify all of the connector details. You must have `all` privileges for
- the **Cases** feature in the **Management**, **Observability**, or
- **Security** section of the Kibana feature privileges, depending on
- where you are creating cases.
+ description: |
+ Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases.
operationId: setCaseConfigurationDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -7657,24 +6998,15 @@ paths:
type: object
properties:
fields:
- description: >-
- The fields specified in the case configuration are not
- used and are not propagated to individual cases,
- therefore it is recommended to set it to `null`.
+ description: The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to `null`.
nullable: true
type: object
id:
- description: >-
- The identifier for the connector. If you do not want a
- default connector, use `none`. To retrieve connector
- IDs, use the find connectors API.
+ description: The identifier for the connector. If you do not want a default connector, use `none`. To retrieve connector IDs, use the find connectors API.
example: none
type: string
name:
- description: >-
- The name of the connector. If you do not want a
- default connector, use `none`. To retrieve connector
- names, use the find connectors API.
+ description: The name of the connector. If you do not want a default connector, use `none`. To retrieve connector names, use the find connectors API.
example: none
type: string
type:
@@ -7711,27 +7043,19 @@ paths:
type: object
properties:
defaultValue:
- description: >
- A default value for the custom field. If the `type`
- is `text`, the default value must be a string. If
- the `type` is `toggle`, the default value must be
- boolean.
+ description: |
+ A default value for the custom field. If the `type` is `text`, the default value must be a string. If the `type` is `toggle`, the default value must be boolean.
oneOf:
- type: string
- type: boolean
key:
- description: >
- A unique key for the custom field. Must be lower
- case and composed only of a-z, 0-9, '_', and '-'
- characters. It is used in API calls to refer to a
- specific custom field.
+ description: |
+ A unique key for the custom field. Must be lower case and composed only of a-z, 0-9, '_', and '-' characters. It is used in API calls to refer to a specific custom field.
maxLength: 36
minLength: 1
type: string
label:
- description: >-
- The custom field label that is displayed in the
- case.
+ description: The custom field label that is displayed in the case.
maxLength: 50
minLength: 1
type: string
@@ -7742,10 +7066,8 @@ paths:
- toggle
type: string
required:
- description: >
- Indicates whether the field is required. If `false`,
- the custom field can be set to null or omitted when
- a case is created or updated.
+ description: |
+ Indicates whether the field is required. If `false`, the custom field can be set to null or omitted when a case is created or updated.
type: boolean
type: array
error:
@@ -7816,14 +7138,8 @@ paths:
- cases
/api/cases/configure/{configurationId}:
patch:
- description: >
- Updates setting details such as the closure type, custom fields,
- templates, and the default connector for cases. Connectors are used to
- interface with external systems. You must create a connector before you
- can use it in your cases. You must have `all` privileges for the
- **Cases** feature in the **Management**, **Observability**, or
- **Security** section of the Kibana feature privileges, depending on
- where the case was created.
+ description: |
+ Updates setting details such as the closure type, custom fields, templates, and the default connector for cases. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where the case was created.
operationId: updateCaseConfigurationDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_kbn_xsrf'
@@ -7842,8 +7158,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
examples:
updateCaseConfigurationResponse:
- $ref: >-
- #/components/examples/Cases_update_case_configuration_response
+ $ref: '#/components/examples/Cases_update_case_configuration_response'
schema:
type: object
properties:
@@ -7853,24 +7168,15 @@ paths:
type: object
properties:
fields:
- description: >-
- The fields specified in the case configuration are not
- used and are not propagated to individual cases,
- therefore it is recommended to set it to `null`.
+ description: The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to `null`.
nullable: true
type: object
id:
- description: >-
- The identifier for the connector. If you do not want a
- default connector, use `none`. To retrieve connector
- IDs, use the find connectors API.
+ description: The identifier for the connector. If you do not want a default connector, use `none`. To retrieve connector IDs, use the find connectors API.
example: none
type: string
name:
- description: >-
- The name of the connector. If you do not want a
- default connector, use `none`. To retrieve connector
- names, use the find connectors API.
+ description: The name of the connector. If you do not want a default connector, use `none`. To retrieve connector names, use the find connectors API.
example: none
type: string
type:
@@ -7907,27 +7213,19 @@ paths:
type: object
properties:
defaultValue:
- description: >
- A default value for the custom field. If the `type`
- is `text`, the default value must be a string. If
- the `type` is `toggle`, the default value must be
- boolean.
+ description: |
+ A default value for the custom field. If the `type` is `text`, the default value must be a string. If the `type` is `toggle`, the default value must be boolean.
oneOf:
- type: string
- type: boolean
key:
- description: >
- A unique key for the custom field. Must be lower
- case and composed only of a-z, 0-9, '_', and '-'
- characters. It is used in API calls to refer to a
- specific custom field.
+ description: |
+ A unique key for the custom field. Must be lower case and composed only of a-z, 0-9, '_', and '-' characters. It is used in API calls to refer to a specific custom field.
maxLength: 36
minLength: 1
type: string
label:
- description: >-
- The custom field label that is displayed in the
- case.
+ description: The custom field label that is displayed in the case.
maxLength: 50
minLength: 1
type: string
@@ -7938,10 +7236,8 @@ paths:
- toggle
type: string
required:
- description: >
- Indicates whether the field is required. If `false`,
- the custom field can be set to null or omitted when
- a case is created or updated.
+ description: |
+ Indicates whether the field is required. If `false`, the custom field can be set to null or omitted when a case is created or updated.
type: boolean
type: array
error:
@@ -8012,10 +7308,8 @@ paths:
- cases
/api/cases/configure/connectors/_find:
get:
- description: >
- Get information about connectors that are supported for use in cases.
- You must have `read` privileges for the **Actions and Connectors**
- feature in the **Management** section of the Kibana feature privileges.
+ description: |
+ Get information about connectors that are supported for use in cases. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
operationId: findCaseConnectorsDefaultSpace
responses:
'200':
@@ -8064,15 +7358,8 @@ paths:
- cases
/api/cases/reporters:
get:
- description: >
- Returns information about the users who opened cases. You must have read
- privileges for the **Cases** feature in the **Management**,
- **Observability**, or **Security** section of the Kibana feature
- privileges, depending on the owner of the cases. The API returns
- information about the users as they existed at the time of the case
- creation, including their name, full name, and email address. If any of
- those details change thereafter or if a user is deleted, the information
- returned by this API is unchanged.
+ description: |
+ Returns information about the users who opened cases. You must have read privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases. The API returns information about the users as they existed at the time of the case creation, including their name, full name, and email address. If any of those details change thereafter or if a user is deleted, the information returned by this API is unchanged.
operationId: getCaseReportersDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner_filter'
@@ -8121,13 +7408,8 @@ paths:
/api/cases/status:
get:
deprecated: true
- description: >
- Returns the number of cases that are open, closed, and in progress.
- Deprecated in 8.1.0. This API is deprecated and will be removed in a
- future release; use the find cases API instead. You must have `read`
- privileges for the **Cases** feature in the **Management**,
- **Observability**, or **Security** section of the Kibana feature
- privileges, depending on the owner of the cases you're seeking.
+ description: |
+ Returns the number of cases that are open, closed, and in progress. Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find cases API instead. You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.
operationId: getCaseStatusDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner_filter'
@@ -8156,11 +7438,8 @@ paths:
- cases
/api/cases/tags:
get:
- description: >
- Aggregates and returns a list of case tags. You must have read
- privileges for the **Cases** feature in the **Management**,
- **Observability**, or **Security** section of the Kibana feature
- privileges, depending on the owner of the cases you're seeking.
+ description: |
+ Aggregates and returns a list of case tags. You must have read privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.
operationId: getCaseTagsDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner_filter'
@@ -8331,9 +7610,8 @@ paths:
- data views
/api/data_views/data_view/{viewId}/fields:
post:
- description: >
- Update fields presentation metadata such as count, customLabel,
- customDescription, and format.
+ description: |
+ Update fields presentation metadata such as count, customLabel, customDescription, and format.
operationId: updateFieldsMetadataDefault
parameters:
- $ref: '#/components/parameters/Data_views_kbn_xsrf'
@@ -8560,8 +7838,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
examples:
getDefaultDataViewResponse:
- $ref: >-
- #/components/examples/Data_views_get_default_data_view_response
+ $ref: '#/components/examples/Data_views_get_default_data_view_response'
schema:
type: object
properties:
@@ -8591,10 +7868,8 @@ paths:
type: object
properties:
data_view_id:
- description: >
- The data view identifier. NOTE: The API does not validate
- whether it is a valid identifier. Use `null` to unset the
- default data view.
+ description: |
+ The data view identifier. NOTE: The API does not validate whether it is a valid identifier. Use `null` to unset the default data view.
nullable: true
type: string
force:
@@ -8625,10 +7900,8 @@ paths:
- data views
/api/data_views/swap_references:
post:
- description: >
- Changes saved object references from one data view identifier to
- another. WARNING: Misuse can break large numbers of saved objects!
- Practicing with a backup is recommended.
+ description: |
+ Changes saved object references from one data view identifier to another. WARNING: Misuse can break large numbers of saved objects! Practicing with a backup is recommended.
operationId: swapDataViewsDefault
parameters:
- $ref: '#/components/parameters/Data_views_kbn_xsrf'
@@ -8672,9 +7945,8 @@ paths:
- data views
/api/data_views/swap_references/_preview:
post:
- description: >
- Preview the impact of swapping saved object references from one data
- view identifier to another.
+ description: |
+ Preview the impact of swapping saved object references from one data view identifier to another.
operationId: previewSwapDataViewsDefault
parameters:
- $ref: '#/components/parameters/Data_views_kbn_xsrf'
@@ -8683,8 +7955,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
examples:
previewSwapDataViewRequest:
- $ref: >-
- #/components/examples/Data_views_preview_swap_data_view_request
+ $ref: '#/components/examples/Data_views_preview_swap_data_view_request'
schema:
$ref: '#/components/schemas/Data_views_swap_data_view_request_object'
required: true
@@ -8729,8 +8000,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
@@ -8753,7 +8023,6 @@ paths:
summary: Delete an alerts index
tags:
- Security Detections API
- - Alert index API
get:
operationId: ReadAlertsIndex
responses:
@@ -8776,8 +8045,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
@@ -8800,7 +8068,6 @@ paths:
summary: Reads the alert index name if it exists
tags:
- Security Detections API
- - Alert index API
post:
operationId: CreateAlertsIndex
responses:
@@ -8819,8 +8086,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
@@ -8843,17 +8109,12 @@ paths:
summary: Create an alerts index
tags:
- Security Detections API
- - Alert index API
/api/detection_engine/privileges:
get:
- description: >
- Retrieves whether or not the user is authenticated, and the user's
- Kibana
-
+ description: |
+ Retrieves whether or not the user is authenticated, and the user's Kibana
space and index privileges, which determine if the user can create an
-
index for the Elastic Security alerts generated by
-
detection engine rules.
operationId: ReadPrivileges
responses:
@@ -8875,8 +8136,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -8887,7 +8147,6 @@ paths:
summary: Returns user privileges for the Kibana space
tags:
- Security Detections API
- - Privileges API
/api/detection_engine/rules:
delete:
description: Delete a detection rule using the `rule_id` or `id` field.
@@ -8915,7 +8174,6 @@ paths:
summary: Delete a detection rule
tags:
- Security Detections API
- - Rules API
get:
description: Retrieve a detection rule using the `rule_id` or `id` field.
operationId: ReadRule
@@ -8942,11 +8200,8 @@ paths:
summary: Retrieve a detection rule
tags:
- Security Detections API
- - Rules API
patch:
- description: >-
- Update specific fields of an existing detection rule using the `rule_id`
- or `id` field.
+ description: Update specific fields of an existing detection rule using the `rule_id` or `id` field.
operationId: PatchRule
requestBody:
content:
@@ -8964,7 +8219,6 @@ paths:
summary: Patch a detection rule
tags:
- Security Detections API
- - Rules API
post:
description: Create a new detection rule.
operationId: CreateRule
@@ -8984,14 +8238,10 @@ paths:
summary: Create a detection rule
tags:
- Security Detections API
- - Rules API
put:
- description: >
- Update a detection rule using the `rule_id` or `id` field. The original
- rule is replaced, and all unspecified fields are deleted.
-
+ description: |
+ Update a detection rule using the `rule_id` or `id` field. The original rule is replaced, and all unspecified fields are deleted.
> info
-
> You cannot modify the `id` or `rule_id` values.
operationId: UpdateRule
requestBody:
@@ -9010,13 +8260,9 @@ paths:
summary: Update a detection rule
tags:
- Security Detections API
- - Rules API
/api/detection_engine/rules/_bulk_action:
post:
- description: >-
- Apply a bulk action, such as bulk edit, duplicate, or delete, to
- multiple detection rules. The bulk action is applied to all rules that
- match the query or to the rules listed by their IDs.
+ description: Apply a bulk action, such as bulk edit, duplicate, or delete, to multiple detection rules. The bulk action is applied to all rules that match the query or to the rules listed by their IDs.
operationId: PerformRulesBulkAction
parameters:
- description: Enables dry run mode for the request call.
@@ -9031,14 +8277,11 @@ paths:
schema:
oneOf:
- $ref: '#/components/schemas/Security_Detections_API_BulkDeleteRules'
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkDisableRules
+ - $ref: '#/components/schemas/Security_Detections_API_BulkDisableRules'
- $ref: '#/components/schemas/Security_Detections_API_BulkEnableRules'
- $ref: '#/components/schemas/Security_Detections_API_BulkExportRules'
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkDuplicateRules
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkManualRuleRun
+ - $ref: '#/components/schemas/Security_Detections_API_BulkDuplicateRules'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkManualRuleRun'
- $ref: '#/components/schemas/Security_Detections_API_BulkEditRules'
responses:
'200':
@@ -9046,15 +8289,12 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkEditActionResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkExportActionResponse
+ - $ref: '#/components/schemas/Security_Detections_API_BulkEditActionResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkExportActionResponse'
description: OK
summary: Apply a bulk action to detection rules
tags:
- Security Detections API
- - Bulk API
/api/detection_engine/rules/_bulk_create:
post:
deprecated: true
@@ -9074,13 +8314,11 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkCrudRulesResponse
+ $ref: '#/components/schemas/Security_Detections_API_BulkCrudRulesResponse'
description: Indicates a successful call.
summary: Create multiple detection rules
tags:
- Security Detections API
- - Bulk API
/api/detection_engine/rules/_bulk_delete:
delete:
deprecated: true
@@ -9096,37 +8334,30 @@ paths:
id:
$ref: '#/components/schemas/Security_Detections_API_RuleObjectId'
rule_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleSignatureId
+ $ref: '#/components/schemas/Security_Detections_API_RuleSignatureId'
type: array
- description: >-
- A JSON array of `id` or `rule_id` fields of the rules you want to
- delete.
+ description: A JSON array of `id` or `rule_id` fields of the rules you want to delete.
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkCrudRulesResponse
+ $ref: '#/components/schemas/Security_Detections_API_BulkCrudRulesResponse'
description: Indicates a successful call.
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -9137,7 +8368,6 @@ paths:
summary: Delete multiple detection rules
tags:
- Security Detections API
- - Bulk API
post:
deprecated: true
description: Deletes multiple rules.
@@ -9152,37 +8382,30 @@ paths:
id:
$ref: '#/components/schemas/Security_Detections_API_RuleObjectId'
rule_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleSignatureId
+ $ref: '#/components/schemas/Security_Detections_API_RuleSignatureId'
type: array
- description: >-
- A JSON array of `id` or `rule_id` fields of the rules you want to
- delete.
+ description: A JSON array of `id` or `rule_id` fields of the rules you want to delete.
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkCrudRulesResponse
+ $ref: '#/components/schemas/Security_Detections_API_BulkCrudRulesResponse'
description: Indicates a successful call.
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -9193,13 +8416,10 @@ paths:
summary: Delete multiple detection rules
tags:
- Security Detections API
- - Bulk API
/api/detection_engine/rules/_bulk_update:
patch:
deprecated: true
- description: >-
- Update specific fields of existing detection rules using the `rule_id`
- or `id` field.
+ description: Update specific fields of existing detection rules using the `rule_id` or `id` field.
operationId: BulkPatchRules
requestBody:
content:
@@ -9215,21 +8435,16 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkCrudRulesResponse
+ $ref: '#/components/schemas/Security_Detections_API_BulkCrudRulesResponse'
description: Indicates a successful call.
summary: Patch multiple detection rules
tags:
- Security Detections API
- - Bulk API
put:
deprecated: true
- description: >
- Update multiple detection rules using the `rule_id` or `id` field. The
- original rules are replaced, and all unspecified fields are deleted.
-
+ description: |
+ Update multiple detection rules using the `rule_id` or `id` field. The original rules are replaced, and all unspecified fields are deleted.
> info
-
> You cannot modify the `id` or `rule_id` values.
operationId: BulkUpdateRules
requestBody:
@@ -9239,34 +8454,25 @@ paths:
items:
$ref: '#/components/schemas/Security_Detections_API_RuleUpdateProps'
type: array
- description: >-
- A JSON array where each element includes the `id` or `rule_id` field
- of the rule you want to update and the fields you want to modify.
+ description: A JSON array where each element includes the `id` or `rule_id` field of the rule you want to update and the fields you want to modify.
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkCrudRulesResponse
+ $ref: '#/components/schemas/Security_Detections_API_BulkCrudRulesResponse'
description: Indicates a successful call.
summary: Update multiple detection rules
tags:
- Security Detections API
- - Bulk API
/api/detection_engine/rules/_export:
post:
- description: >
- Export detection rules to an `.ndjson` file. The following configuration
- items are also included in the `.ndjson` file:
-
+ description: |
+ Export detection rules to an `.ndjson` file. The following configuration items are also included in the `.ndjson` file:
- Actions
-
- Exception lists
-
> info
-
> You cannot export prebuilt rules.
operationId: ExportRules
parameters:
@@ -9292,15 +8498,12 @@ paths:
type: object
properties:
objects:
- description: >-
- Array of `rule_id` fields. Exports all rules when
- unspecified.
+ description: Array of `rule_id` fields. Exports all rules when unspecified.
items:
type: object
properties:
rule_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleSignatureId
+ $ref: '#/components/schemas/Security_Detections_API_RuleSignatureId'
required:
- rule_id
type: array
@@ -9319,12 +8522,9 @@ paths:
summary: Export detection rules
tags:
- Security Detections API
- - Import/Export API
/api/detection_engine/rules/_find:
get:
- description: >-
- Retrieve a paginated list of detection rules. By default, the first page
- is returned, with 20 results per page.
+ description: Retrieve a paginated list of detection rules. By default, the first page is returned, with 20 results per page.
operationId: FindRules
parameters:
- in: query
@@ -9377,8 +8577,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleResponse
+ $ref: '#/components/schemas/Security_Detections_API_RuleResponse'
type: array
page:
type: integer
@@ -9395,39 +8594,29 @@ paths:
summary: List all detection rules
tags:
- Security Detections API
- - Rules API
/api/detection_engine/rules/_import:
post:
- description: >
- Import detection rules from an `.ndjson` file, including actions and
- exception lists. The request must include:
-
+ description: |
+ Import detection rules from an `.ndjson` file, including actions and exception lists. The request must include:
- The `Content-Type: multipart/form-data` HTTP header.
-
- A link to the `.ndjson` file containing the rules.
operationId: ImportRules
parameters:
- - description: >-
- Determines whether existing rules with the same `rule_id` are
- overwritten.
+ - description: Determines whether existing rules with the same `rule_id` are overwritten.
in: query
name: overwrite
required: false
schema:
default: false
type: boolean
- - description: >-
- Determines whether existing exception lists with the same `list_id`
- are overwritten.
+ - description: Determines whether existing exception lists with the same `list_id` are overwritten.
in: query
name: overwrite_exceptions
required: false
schema:
default: false
type: boolean
- - description: >-
- Determines whether existing actions with the same
- `kibana.alert.rule.actions.id` are overwritten.
+ - description: Determines whether existing actions with the same `kibana.alert.rule.actions.id` are overwritten.
in: query
name: overwrite_action_connectors
required: false
@@ -9471,8 +8660,7 @@ paths:
type: integer
action_connectors_warnings:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_WarningSchema
+ $ref: '#/components/schemas/Security_Detections_API_WarningSchema'
type: array
errors:
items:
@@ -9511,7 +8699,6 @@ paths:
summary: Import detection rules
tags:
- Security Detections API
- - Import/Export API
/api/detection_engine/rules/{id}/exceptions:
post:
description: Create exception items that apply to a single detection rule.
@@ -9531,8 +8718,7 @@ paths:
properties:
items:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemProps
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemProps'
type: array
required:
- items
@@ -9544,8 +8730,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItem
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItem'
type: array
description: Successful response
'400':
@@ -9553,24 +8738,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'500':
content:
@@ -9618,12 +8799,9 @@ paths:
summary: Install prebuilt detection rules and Timelines
tags:
- Security Detections API
- - Prebuilt Rules API
/api/detection_engine/rules/prepackaged/_status:
get:
- description: >-
- Retrieve the status of all Elastic prebuilt detection rules and
- Timelines.
+ description: Retrieve the status of all Elastic prebuilt detection rules and Timelines.
operationId: ReadPrebuiltRulesAndTimelinesStatus
responses:
'200':
@@ -9642,9 +8820,7 @@ paths:
minimum: 0
type: integer
rules_not_installed:
- description: >-
- The total number of available prebuilt rules that are not
- installed
+ description: The total number of available prebuilt rules that are not installed
minimum: 0
type: integer
rules_not_updated:
@@ -9656,9 +8832,7 @@ paths:
minimum: 0
type: integer
timelines_not_installed:
- description: >-
- The total number of available prebuilt timelines that are
- not installed
+ description: The total number of available prebuilt timelines that are not installed
minimum: 0
type: integer
timelines_not_updated:
@@ -9677,14 +8851,11 @@ paths:
summary: Retrieve the status of prebuilt detection rules and Timelines
tags:
- Security Detections API
- - Prebuilt Rules API
/api/detection_engine/rules/preview:
post:
operationId: RulePreview
parameters:
- - description: >-
- Enables logging and returning in response ES queries, performed
- during rule execution
+ - description: Enables logging and returning in response ES queries, performed during rule execution
in: query
name: enable_logged_requests
required: false
@@ -9696,50 +8867,32 @@ paths:
schema:
anyOf:
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_EqlRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_EqlRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_QueryRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_QueryRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
- allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_EsqlRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewParams
+ - $ref: '#/components/schemas/Security_Detections_API_EsqlRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_RulePreviewParams'
discriminator:
propertyName: type
- description: >-
- An object containing tags to add or remove and alert ids the changes
- will be applied
+ description: An object containing tags to add or remove and alert ids the changes will be applied
required: true
responses:
'200':
@@ -9752,12 +8905,10 @@ paths:
type: boolean
logs:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewLogs
+ $ref: '#/components/schemas/Security_Detections_API_RulePreviewLogs'
type: array
previewId:
- $ref: >-
- #/components/schemas/Security_Detections_API_NonEmptyString
+ $ref: '#/components/schemas/Security_Detections_API_NonEmptyString'
required:
- logs
description: Successful response
@@ -9766,17 +8917,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -9787,7 +8935,6 @@ paths:
summary: Preview rule alerts generated on specified time range
tags:
- Security Detections API
- - Rule preview API
/api/detection_engine/signals/assignees:
post:
description: |
@@ -9821,13 +8968,9 @@ paths:
- Security Detections API
/api/detection_engine/signals/finalize_migration:
post:
- description: >
- Finalize successful migrations of detection alerts. This replaces the
- original index's alias with the successfully migrated index's alias.
-
- The endpoint is idempotent; therefore, it can safely be used to poll a
- given migration and, upon completion,
-
+ description: |
+ Finalize successful migrations of detection alerts. This replaces the original index's alias with the successfully migrated index's alias.
+ The endpoint is idempotent; therefore, it can safely be used to poll a given migration and, upon completion,
finalize it.
operationId: FinalizeAlertsMigration
requestBody:
@@ -9851,8 +8994,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_MigrationFinalizationResult
+ $ref: '#/components/schemas/Security_Detections_API_MigrationFinalizationResult'
type: array
description: Successful response
'400':
@@ -9860,17 +9002,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -9881,26 +9020,16 @@ paths:
summary: Finalize detection alert migrations
tags:
- Security Detections API
- - Alerts migration API
/api/detection_engine/signals/migration:
delete:
- description: >
- Migrations favor data integrity over shard size. Consequently, unused or
- orphaned indices are artifacts of
-
- the migration process. A successful migration will result in both the
- old and new indices being present.
-
+ description: |
+ Migrations favor data integrity over shard size. Consequently, unused or orphaned indices are artifacts of
+ the migration process. A successful migration will result in both the old and new indices being present.
As such, the old, orphaned index can (and likely should) be deleted.
-
While you can delete these indices manually,
-
- the endpoint accomplishes this task by applying a deletion policy to the
- relevant index, causing it to be deleted
-
- after 30 days. It also deletes other artifacts specific to the migration
- implementation.
+ the endpoint accomplishes this task by applying a deletion policy to the relevant index, causing it to be deleted
+ after 30 days. It also deletes other artifacts specific to the migration implementation.
operationId: AlertsMigrationCleanup
requestBody:
content:
@@ -9923,8 +9052,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_MigrationCleanupResult
+ $ref: '#/components/schemas/Security_Detections_API_MigrationCleanupResult'
type: array
description: Successful response
'400':
@@ -9932,17 +9060,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -9953,15 +9078,10 @@ paths:
summary: Clean up detection alert migrations
tags:
- Security Detections API
- - Alerts migration API
post:
- description: >
+ description: |
Initiate a migration of detection alerts.
-
- Migrations are initiated per index. While the process is neither
- destructive nor interferes with existing data, it may be
- resource-intensive. As such, it is recommended that you plan your
- migrations accordingly.
+ Migrations are initiated per index. While the process is neither destructive nor interferes with existing data, it may be resource-intensive. As such, it is recommended that you plan your migrations accordingly.
operationId: CreateAlertsMigration
requestBody:
content:
@@ -9972,14 +9092,12 @@ paths:
properties:
index:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_NonEmptyString
+ $ref: '#/components/schemas/Security_Detections_API_NonEmptyString'
minItems: 1
type: array
required:
- index
- - $ref: >-
- #/components/schemas/Security_Detections_API_AlertsReindexOptions
+ - $ref: '#/components/schemas/Security_Detections_API_AlertsReindexOptions'
description: Alerts migration parameters
required: true
responses:
@@ -9992,12 +9110,9 @@ paths:
indices:
items:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexMigrationSuccess
- - $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexMigrationError
- - $ref: >-
- #/components/schemas/Security_Detections_API_SkippedAlertsIndexMigration
+ - $ref: '#/components/schemas/Security_Detections_API_AlertsIndexMigrationSuccess'
+ - $ref: '#/components/schemas/Security_Detections_API_AlertsIndexMigrationError'
+ - $ref: '#/components/schemas/Security_Detections_API_SkippedAlertsIndexMigration'
type: array
required:
- indices
@@ -10007,17 +9122,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -10028,12 +9140,9 @@ paths:
summary: Initiate a detection alert migration
tags:
- Security Detections API
- - Alerts migration API
/api/detection_engine/signals/migration_status:
post:
- description: >-
- Retrieve indices that contain detection alerts of a particular age,
- along with migration information for each of those indices.
+ description: Retrieve indices that contain detection alerts of a particular age, along with migration information for each of those indices.
operationId: ReadAlertsMigrationStatus
parameters:
- description: Maximum age of qualifying detection alerts
@@ -10041,12 +9150,9 @@ paths:
name: from
required: true
schema:
- description: >
- Time from which data is analyzed. For example, now-4200s means the
- rule analyzes data from 70 minutes
-
- before its start time. Defaults to now-6m (analyzes data from 6
- minutes before the start time).
+ description: |
+ Time from which data is analyzed. For example, now-4200s means the rule analyzes data from 70 minutes
+ before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
format: date-math
type: string
responses:
@@ -10058,8 +9164,7 @@ paths:
properties:
indices:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_IndexMigrationStatus
+ $ref: '#/components/schemas/Security_Detections_API_IndexMigrationStatus'
type: array
required:
- indices
@@ -10069,17 +9174,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -10090,7 +9192,6 @@ paths:
summary: Retrieve the status of detection alert migrations
tags:
- Security Detections API
- - Alerts migration API
/api/detection_engine/signals/search:
post:
description: Find and/or aggregate detection alerts that match the given query.
@@ -10145,17 +9246,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -10166,7 +9264,6 @@ paths:
summary: Find and/or aggregate detection alerts
tags:
- Security Detections API
- - Alerts API
/api/detection_engine/signals/status:
post:
description: Set the status of one or more detection alerts.
@@ -10176,13 +9273,9 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_SetAlertsStatusByIds
- - $ref: >-
- #/components/schemas/Security_Detections_API_SetAlertsStatusByQuery
- description: >-
- An object containing desired status and explicit alert ids or a query
- to select alerts
+ - $ref: '#/components/schemas/Security_Detections_API_SetAlertsStatusByIds'
+ - $ref: '#/components/schemas/Security_Detections_API_SetAlertsStatusByQuery'
+ description: An object containing desired status and explicit alert ids or a query to select alerts
required: true
responses:
'200':
@@ -10198,17 +9291,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -10219,7 +9309,6 @@ paths:
summary: Set a detection alert status
tags:
- Security Detections API
- - Alerts API
/api/detection_engine/signals/tags:
post:
description: |
@@ -10240,9 +9329,7 @@ paths:
required:
- ids
- tags
- description: >-
- An object containing tags to add or remove and alert ids the changes
- will be applied
+ description: An object containing tags to add or remove and alert ids the changes will be applied
required: true
responses:
'200':
@@ -10258,17 +9345,14 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Detections_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Detections_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Detections_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Detections_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'500':
content:
@@ -10279,7 +9363,6 @@ paths:
summary: Add and remove detection alert tags
tags:
- Security Detections API
- - Alerts API
/api/detection_engine/tags:
get:
description: List all unique tags from all detection rules.
@@ -10294,45 +9377,26 @@ paths:
summary: List all detection rule tags
tags:
- Security Detections API
- - Tags API
/api/encrypted_saved_objects/_rotate_key:
post:
- description: >
+ description: |
Superuser role required.
+ If a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.
- If a saved object cannot be decrypted using the primary encryption key,
- then Kibana will attempt to decrypt it using the specified
- decryption-only keys. In most of the cases this overhead is negligible,
- but if you're dealing with a large number of saved objects and
- experiencing performance issues, you may want to rotate the encryption
- key.
-
-
- This functionality is in technical preview and may be changed or removed
- in a future release. Elastic will work to fix any issues, but features
- in technical preview are not subject to the support SLA of official GA
- features.
+ This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
operationId: rotateEncryptionKey
parameters:
- - description: >
- Specifies a maximum number of saved objects that Kibana can process
- in a single batch. Bulk key rotation is an iterative process since
- Kibana may not be able to fetch and process all required saved
- objects in one go and splits processing into consequent batches. By
- default, the batch size is 10000, which is also a maximum allowed
- value.
+ - description: |
+ Specifies a maximum number of saved objects that Kibana can process in a single batch. Bulk key rotation is an iterative process since Kibana may not be able to fetch and process all required saved objects in one go and splits processing into consequent batches. By default, the batch size is 10000, which is also a maximum allowed value.
in: query
name: batch_size
required: false
schema:
default: 10000
type: number
- - description: >
- Limits encryption key rotation only to the saved objects with the
- specified type. By default, Kibana tries to rotate the encryption
- key for all saved object types that may contain encrypted
- attributes.
+ - description: |
+ Limits encryption key rotation only to the saved objects with the specified type. By default, Kibana tries to rotate the encryption key for all saved object types that may contain encrypted attributes.
in: query
name: type
required: false
@@ -10349,28 +9413,18 @@ paths:
type: object
properties:
failed:
- description: >
- Indicates the number of the saved objects that were still
- encrypted with one of the old encryption keys that Kibana
- failed to re-encrypt with the primary key.
+ description: |
+ Indicates the number of the saved objects that were still encrypted with one of the old encryption keys that Kibana failed to re-encrypt with the primary key.
type: number
successful:
- description: >
- Indicates the total number of all encrypted saved objects
- (optionally filtered by the requested `type`), regardless
- of the key Kibana used for encryption.
-
+ description: |
+ Indicates the total number of all encrypted saved objects (optionally filtered by the requested `type`), regardless of the key Kibana used for encryption.
- NOTE: In most cases, `total` will be greater than
- `successful` even if `failed` is zero. The reason is that
- Kibana may not need or may not be able to rotate
- encryption keys for all encrypted saved objects.
+ NOTE: In most cases, `total` will be greater than `successful` even if `failed` is zero. The reason is that Kibana may not need or may not be able to rotate encryption keys for all encrypted saved objects.
type: number
total:
- description: >
- Indicates the total number of all encrypted saved objects
- (optionally filtered by the requested `type`), regardless
- of the key Kibana used for encryption.
+ description: |
+ Indicates the total number of all encrypted saved objects (optionally filtered by the requested `type`), regardless of the key Kibana used for encryption.
type: number
description: Indicates a successful call.
'400':
@@ -10390,58 +9444,47 @@ paths:
- saved objects
/api/endpoint_list:
post:
- description: >-
- Create an endpoint exception list, which groups endpoint exception list
- items. If an endpoint exception list already exists, an empty response
- is returned.
+ description: Create an endpoint exception list, which groups endpoint exception list items. If an endpoint exception list already exists, an empty response is returned.
operationId: CreateEndpointList
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointList
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointList'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Create an endpoint exception list
tags:
- Security Endpoint Exceptions API
/api/endpoint_list/items:
delete:
- description: >-
- Delete an endpoint exception list item using the `id` or `item_id`
- field.
+ description: Delete an endpoint exception list item using the `id` or `item_id` field.
operationId: DeleteEndpointListItem
parameters:
- description: Either `id` or `item_id` must be specified
@@ -10449,68 +9492,57 @@ paths:
name: id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId'
- description: Either `id` or `item_id` must be specified
in: query
name: item_id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list item not found
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Delete an endpoint exception list item
tags:
- Security Endpoint Exceptions API
get:
- description: >-
- Get the details of an endpoint exception list item using the `id` or
- `item_id` field.
+ description: Get the details of an endpoint exception list item using the `id` or `item_id` field.
operationId: ReadEndpointListItem
parameters:
- description: Either `id` or `item_id` must be specified
@@ -10518,23 +9550,20 @@ paths:
name: id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId'
- description: Either `id` or `item_id` must be specified
in: query
name: item_id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
type: array
description: Successful response
'400':
@@ -10542,46 +9571,38 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list item not found
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Get an endpoint exception list item
tags:
- Security Endpoint Exceptions API
post:
- description: >-
- Create an endpoint exception list item, and associate it with the
- endpoint exception list.
+ description: Create an endpoint exception list item, and associate it with the endpoint exception list.
operationId: CreateEndpointListItem
requestBody:
content:
@@ -10590,35 +9611,26 @@ paths:
type: object
properties:
comments:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray'
item_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName'
os_types:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags'
default: []
type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType'
required:
- type
- name
@@ -10631,54 +9643,45 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'409':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list item already exists
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Create an endpoint exception list item
tags:
- Security Endpoint Exceptions API
put:
- description: >-
- Update an endpoint exception list item using the `id` or `item_id`
- field.
+ description: Update an endpoint exception list item using the `id` or `item_id` field.
operationId: UpdateEndpointListItem
requestBody:
content:
@@ -10689,39 +9692,29 @@ paths:
_version:
type: string
comments:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray'
id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId'
description: Either `id` or `item_id` must be specified
item_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
description: Either `id` or `item_id` must be specified
meta:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName'
os_types:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags'
type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType'
required:
- type
- name
@@ -10734,46 +9727,39 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list item not found
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Update an endpoint exception list item
tags:
@@ -10783,17 +9769,14 @@ paths:
description: Get a list of all endpoint exception list items.
operationId: FindEndpointListItems
parameters:
- - description: >
- Filters the returned results according to the value of the specified
- field,
-
+ - description: |
+ Filters the returned results according to the value of the specified field,
using the `:` syntax.
in: query
name: filter
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_FindEndpointListItemsFilter
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_FindEndpointListItemsFilter'
- description: The page number to return
in: query
name: page
@@ -10813,8 +9796,7 @@ paths:
name: sort_field
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
- description: Determines the sort order, which can be `desc` or `asc`
in: query
name: sort_order
@@ -10833,8 +9815,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_EndpointListItem'
type: array
page:
minimum: 0
@@ -10858,38 +9839,32 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Invalid input data
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_PlatformErrorResponse'
description: Insufficient privileges
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Endpoint list not found
'500':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse'
description: Internal server error
summary: Get endpoint exception list items
tags:
@@ -10903,15 +9878,13 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_GetEndpointActionListRouteQuery
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_GetEndpointActionListRouteQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get response actions
tags:
@@ -10934,8 +9907,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ActionStatusSuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ActionStatusSuccessResponse'
description: OK
summary: Get response actions status
tags:
@@ -10955,8 +9927,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get action details
tags:
@@ -10981,8 +9952,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get file information
tags:
@@ -11007,8 +9977,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Download a file
tags:
@@ -11021,16 +9990,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ExecuteRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ExecuteRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Run a command
tags:
@@ -11043,40 +10010,34 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_GetFileRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_GetFileRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get a file
tags:
- Security Endpoint Management API
/api/endpoint/action/isolate:
post:
- description: >-
- Isolate an endpoint from the network. The endpoint remains isolated
- until it's released.
+ description: Isolate an endpoint from the network. The endpoint remains isolated until it's released.
operationId: EndpointIsolateAction
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_IsolateRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_IsolateRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Isolate an endpoint
tags:
@@ -11089,16 +10050,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_KillProcessRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_KillProcessRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Terminate a process
tags:
@@ -11111,16 +10070,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_GetProcessesRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_GetProcessesRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get running processes
tags:
@@ -11133,33 +10090,28 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ScanRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ScanRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Scan a file or directory
tags:
- Security Endpoint Management API
/api/endpoint/action/state:
get:
- description: >-
- Get a response actions state, which reports whether encryption is
- enabled.
+ description: Get a response actions state, which reports whether encryption is enabled.
operationId: EndpointGetActionsState
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ActionStateSuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ActionStateSuccessResponse'
description: OK
summary: Get actions state
tags:
@@ -11172,16 +10124,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuspendProcessRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuspendProcessRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Suspend a process
tags:
@@ -11194,16 +10144,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_UnisolateRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_UnisolateRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Release an isolated endpoint
tags:
@@ -11216,16 +10164,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_UploadRouteRequestBody
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_UploadRouteRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Upload a file
tags:
@@ -11238,15 +10184,13 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ListRequestQuery
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ListRequestQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get a metadata list
tags:
@@ -11265,8 +10209,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get metadata
tags:
@@ -11288,8 +10231,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_SuccessResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_SuccessResponse'
description: OK
summary: Get a policy response
tags:
@@ -11308,8 +10250,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse'
description: OK
summary: Get a protection updates note
tags:
@@ -11336,12 +10277,47 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse'
description: OK
summary: Create or update a protection updates note
tags:
- Security Endpoint Management API
+ /api/entity_store/enable:
+ post:
+ operationId: InitEntityStore
+ requestBody:
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ schema:
+ type: object
+ properties:
+ fieldHistoryLength:
+ default: 10
+ description: The number of historical values to keep for each field.
+ type: integer
+ filter:
+ type: string
+ indexPattern:
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_IndexPattern'
+ description: Schema for the entity store initialization
+ required: true
+ responses:
+ '200':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ schema:
+ type: object
+ properties:
+ engines:
+ items:
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
+ type: array
+ succeeded:
+ type: boolean
+ description: Successful response
+ summary: Initialize the Entity Store
+ tags:
+ - Security Entity Analytics API
/api/entity_store/engines:
get:
operationId: ListEntityEngines
@@ -11356,8 +10332,7 @@ paths:
type: integer
engines:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDescriptor
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
type: array
description: Successful response
summary: List the Entity Engines
@@ -11406,8 +10381,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDescriptor
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
description: Successful response
summary: Get an Entity Engine
tags:
@@ -11435,8 +10409,7 @@ paths:
filter:
type: string
indexPattern:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_IndexPattern
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_IndexPattern'
description: Schema for the engine initialization
required: true
responses:
@@ -11444,8 +10417,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDescriptor
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
description: Successful response
summary: Initialize an Entity Engine
tags:
@@ -11491,22 +10463,19 @@ paths:
type: object
properties:
indexPattern:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_IndexPattern
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_IndexPattern'
indices:
items:
type: object
type: array
status:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineStatus
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineStatus'
transforms:
items:
type: object
type: array
type:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EntityType
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EntityType'
description: Successful response
summary: Get Entity Engine stats
tags:
@@ -11546,8 +10515,7 @@ paths:
properties:
result:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDataviewUpdateResult
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDataviewUpdateResult'
type: array
success:
type: boolean
@@ -11564,8 +10532,7 @@ paths:
type: array
result:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EngineDataviewUpdateResult
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDataviewUpdateResult'
type: array
success:
type: boolean
@@ -11636,8 +10603,7 @@ paths:
type: object
properties:
inspect:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_InspectQuery
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_InspectQuery'
page:
minimum: 1
type: integer
@@ -11647,8 +10613,7 @@ paths:
type: integer
records:
items:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_Entity
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
type: array
total:
minimum: 0
@@ -11662,6 +10627,26 @@ paths:
summary: List Entity Store Entities
tags:
- Security Entity Analytics API
+ /api/entity_store/status:
+ get:
+ operationId: GetEntityStoreStatus
+ responses:
+ '200':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ schema:
+ type: object
+ properties:
+ engines:
+ items:
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EngineDescriptor'
+ type: array
+ status:
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_StoreStatus'
+ description: Successful response
+ summary: Get the status of the Entity Store
+ tags:
+ - Security Entity Analytics API
/api/exception_lists:
delete:
description: Delete an exception list using the `id` or `list_id` field.
@@ -11683,8 +10668,7 @@ paths:
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
responses:
'200':
@@ -11698,24 +10682,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -11752,8 +10732,7 @@ paths:
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
responses:
'200':
@@ -11767,24 +10746,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -11802,19 +10777,10 @@ paths:
tags:
- Security Exceptions API
post:
- description: >
- An exception list groups exception items and can be associated with
- detection rules. You can assign detection rules with multiple exception
- lists.
-
+ description: |
+ An exception list groups exception items and can be associated with detection rules. You can assign detection rules with multiple exception lists.
> info
-
- > All exception items added to the same list are evaluated using `OR`
- logic. That is, if any of the items in a list evaluate to `true`, the
- exception prevents the rule from generating an alert. Likewise, `OR`
- logic is used for evaluating exceptions when more than one exception
- list is assigned to a rule. To use the `AND` operator, you can define
- multiple clauses (`entries`) in a single exception item.
+ > All exception items added to the same list are evaluated using `OR` logic. That is, if any of the items in a list evaluate to `true`, the exception prevents the rule from generating an alert. Likewise, `OR` logic is used for evaluating exceptions when more than one exception list is assigned to a rule. To use the `AND` operator, you can define multiple clauses (`entries`) in a single exception item.
operationId: CreateExceptionList
requestBody:
content:
@@ -11823,34 +10789,25 @@ paths:
type: object
properties:
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListDescription'
list_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListMeta
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListMeta'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray'
tags:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListTags
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListTags'
default: []
type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListType'
version:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListVersion
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListVersion'
default: 1
required:
- name
@@ -11870,24 +10827,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'409':
content:
@@ -11916,36 +10869,27 @@ paths:
_version:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListDescription'
id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListId'
list_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListMeta
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListMeta'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListTags
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListTags'
type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListType'
version:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListVersion
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListVersion'
required:
- name
- description
@@ -11964,24 +10908,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -12013,11 +10953,8 @@ paths:
name: namespace_type
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
- - description: >-
- Determines whether to include expired exceptions in the exported
- list
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
+ - description: Determines whether to include expired exceptions in the exported list
in: query
name: include_expired_exceptions
required: true
@@ -12039,24 +10976,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'405':
content:
@@ -12094,11 +11027,8 @@ paths:
name: namespace_type
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
- - description: >-
- Determines whether to include expired exceptions in the exported
- list
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
+ - description: Determines whether to include expired exceptions in the exported list
in: query
name: include_expired_exceptions
required: true
@@ -12113,9 +11043,7 @@ paths:
content:
application/ndjson; Elastic-Api-Version=2023-10-31:
schema:
- description: >-
- A `.ndjson` file containing specified exception list and its
- items
+ description: A `.ndjson` file containing specified exception list and its items
format: binary
type: string
description: Successful response
@@ -12124,24 +11052,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -12163,29 +11087,20 @@ paths:
description: Get a list of all exception lists.
operationId: FindExceptionLists
parameters:
- - description: >
- Filters the returned results according to the value of the specified
- field.
-
-
- Uses the `so type.field name:field` value syntax, where `so type`
- can be:
+ - description: |
+ Filters the returned results according to the value of the specified field.
+ Uses the `so type.field name:field` value syntax, where `so type` can be:
- `exception-list`: Specify a space-aware exception list.
-
- - `exception-list-agnostic`: Specify an exception list that is
- shared across spaces.
+ - `exception-list-agnostic`: Specify an exception list that is shared across spaces.
in: query
name: filter
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_FindExceptionListsFilter
- - description: >
- Determines whether the returned containers are Kibana associated
- with a Kibana space
-
+ $ref: '#/components/schemas/Security_Exceptions_API_FindExceptionListsFilter'
+ - description: |
+ Determines whether the returned containers are Kibana associated with a Kibana space
or available in all spaces (`agnostic` or `single`)
in: query
name: namespace_type
@@ -12194,8 +11109,7 @@ paths:
default:
- single
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
type: array
- description: The page number to return
in: query
@@ -12235,8 +11149,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionList
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionList'
type: array
page:
minimum: 1
@@ -12258,24 +11171,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'500':
content:
@@ -12291,12 +11200,9 @@ paths:
description: Import an exception list and its associated items from an NDJSON file.
operationId: ImportExceptionList
parameters:
- - description: >
- Determines whether existing exception lists with the same `list_id`
- are overwritten.
-
- If any exception items have the same `item_id`, those are also
- overwritten.
+ - description: |
+ Determines whether existing exception lists with the same `list_id` are overwritten.
+ If any exception items have the same `item_id`, those are also overwritten.
in: query
name: overwrite
required: false
@@ -12315,13 +11221,9 @@ paths:
schema:
default: false
type: boolean
- - description: >
- Determines whether the list being imported will have a new `list_id`
- generated.
-
- Additional `item_id`'s are generated for each exception item. Both
- the exception
-
+ - description: |
+ Determines whether the list being imported will have a new `list_id` generated.
+ Additional `item_id`'s are generated for each exception item. Both the exception
list and its items are overwritten.
in: query
name: as_new_list
@@ -12348,8 +11250,7 @@ paths:
type: object
properties:
errors:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListsImportBulkErrorArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListsImportBulkErrorArray'
success:
type: boolean
success_count:
@@ -12379,24 +11280,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'500':
content:
@@ -12423,14 +11320,12 @@ paths:
name: item_id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
- in: query
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
responses:
'200':
@@ -12444,24 +11339,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -12479,9 +11370,7 @@ paths:
tags:
- Security Exceptions API
get:
- description: >-
- Get the details of an exception list item using the `id` or `item_id`
- field.
+ description: Get the details of an exception list item using the `id` or `item_id` field.
operationId: ReadExceptionListItem
parameters:
- description: Either `id` or `item_id` must be specified
@@ -12495,14 +11384,12 @@ paths:
name: item_id
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
- in: query
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
responses:
'200':
@@ -12516,24 +11403,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -12551,12 +11434,9 @@ paths:
tags:
- Security Exceptions API
post:
- description: >
- Create an exception item and associate it with the specified exception
- list.
-
+ description: |
+ Create an exception item and associate it with the specified exception list.
> info
-
> Before creating exception items, you must create an exception list.
operationId: CreateExceptionListItem
requestBody:
@@ -12566,45 +11446,34 @@ paths:
type: object
properties:
comments:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
list_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemTags'
default: []
type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemType'
required:
- list_id
- type
@@ -12625,24 +11494,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'409':
content:
@@ -12671,49 +11536,37 @@ paths:
_version:
type: string
comments:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_UpdateExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Exceptions_API_UpdateExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemId'
description: Either `id` or `item_id` must be specified
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
description: Either `id` or `item_id` must be specified
list_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemTags'
type:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemType'
required:
- type
- name
@@ -12733,24 +11586,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -12778,13 +11627,10 @@ paths:
required: true
schema:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
type: array
- - description: >
- Filters the returned results according to the value of the specified
- field,
-
+ - description: |
+ Filters the returned results according to the value of the specified field,
using the `:` syntax.
in: query
name: filter
@@ -12792,13 +11638,10 @@ paths:
schema:
default: []
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_FindExceptionListItemsFilter
+ $ref: '#/components/schemas/Security_Exceptions_API_FindExceptionListItemsFilter'
type: array
- - description: >
- Determines whether the returned containers are Kibana associated
- with a Kibana space
-
+ - description: |
+ Determines whether the returned containers are Kibana associated with a Kibana space
or available in all spaces (`agnostic` or `single`)
in: query
name: namespace_type
@@ -12807,8 +11650,7 @@ paths:
default:
- single
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
type: array
- in: query
name: search
@@ -12853,8 +11695,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItem
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItem'
type: array
page:
minimum: 1
@@ -12878,24 +11719,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -12933,8 +11770,7 @@ paths:
name: namespace_type
required: false
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
- description: Search filter clause
in: query
@@ -12967,24 +11803,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'404':
content:
@@ -13003,19 +11835,10 @@ paths:
- Security Exceptions API
/api/exceptions/shared:
post:
- description: >
- An exception list groups exception items and can be associated with
- detection rules. A shared exception list can apply to multiple detection
- rules.
-
+ description: |
+ An exception list groups exception items and can be associated with detection rules. A shared exception list can apply to multiple detection rules.
> info
-
- > All exception items added to the same list are evaluated using `OR`
- logic. That is, if any of the items in a list evaluate to `true`, the
- exception prevents the rule from generating an alert. Likewise, `OR`
- logic is used for evaluating exceptions when more than one exception
- list is assigned to a rule. To use the `AND` operator, you can define
- multiple clauses (`entries`) in a single exception item.
+ > All exception items added to the same list are evaluated using `OR` logic. That is, if any of the items in a list evaluate to `true`, the exception prevents the rule from generating an alert. Likewise, `OR` logic is used for evaluating exceptions when more than one exception list is assigned to a rule. To use the `AND` operator, you can define multiple clauses (`entries`) in a single exception item.
operationId: CreateSharedExceptionList
requestBody:
content:
@@ -13024,11 +11847,9 @@ paths:
type: object
properties:
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListDescription'
name:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListName
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListName'
required:
- name
- description
@@ -13045,24 +11866,20 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_SiemErrorResponse
+ - $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
+ - $ref: '#/components/schemas/Security_Exceptions_API_SiemErrorResponse'
description: Invalid input data response
'401':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Unsuccessful authentication response
'403':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_PlatformErrorResponse
+ $ref: '#/components/schemas/Security_Exceptions_API_PlatformErrorResponse'
description: Not enough privileges response
'409':
content:
@@ -13115,9 +11932,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source.
- See the proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -13191,9 +12006,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source. See the
- proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -13222,9 +12035,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source.
- See the proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -13348,9 +12159,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source.
- See the proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -13420,9 +12229,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source. See the
- proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -13451,9 +12258,7 @@ paths:
name:
type: string
proxy_id:
- description: >-
- The ID of the proxy to use for this download source.
- See the proxies API for more information.
+ description: The ID of the proxy to use for this download source. See the proxies API for more information.
nullable: true
type: string
required:
@@ -13610,9 +12415,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -13644,15 +12447,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -13719,11 +12518,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -13731,10 +12526,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list
- of agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -13780,9 +12572,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -13810,9 +12600,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -13865,9 +12653,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -13888,9 +12674,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -13904,20 +12688,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank
- to inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -13966,16 +12744,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package
- policy will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -14006,9 +12780,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -14038,9 +12810,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports
- agentless integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -14169,9 +12939,7 @@ paths:
force:
type: boolean
global_data_tags:
- description: >-
- User defined data tags that are added to all of the inputs.
- The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -14204,9 +12972,7 @@ paths:
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -14273,11 +13039,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
space_ids:
@@ -14286,9 +13048,7 @@ paths:
type: array
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -14353,9 +13113,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -14387,15 +13145,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -14462,11 +13216,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -14474,10 +13224,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list of
- agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -14523,9 +13270,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -14553,9 +13298,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -14608,9 +13351,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -14631,9 +13372,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -14647,20 +13386,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -14709,16 +13442,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -14749,9 +13478,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -14781,9 +13508,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -14931,9 +13656,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -14965,15 +13688,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -15040,11 +13759,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -15052,10 +13767,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list
- of agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -15101,9 +13813,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -15131,9 +13841,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -15186,9 +13894,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -15209,9 +13915,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -15225,20 +13929,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank
- to inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -15287,16 +13985,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package
- policy will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -15327,9 +14021,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -15359,9 +14051,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports
- agentless integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -15489,9 +14179,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -15523,15 +14211,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -15598,11 +14282,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -15610,10 +14290,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list of
- agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -15659,9 +14336,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -15689,9 +14364,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -15744,9 +14417,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -15767,9 +14438,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -15783,20 +14452,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -15845,16 +14508,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -15885,9 +14544,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -15917,9 +14574,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -16047,9 +14702,7 @@ paths:
force:
type: boolean
global_data_tags:
- description: >-
- User defined data tags that are added to all of the inputs.
- The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -16082,9 +14735,7 @@ paths:
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -16151,11 +14802,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
space_ids:
@@ -16164,9 +14811,7 @@ paths:
type: array
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -16231,9 +14876,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -16265,15 +14908,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -16340,11 +14979,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -16352,10 +14987,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list of
- agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -16401,9 +15033,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -16431,9 +15061,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -16486,9 +15114,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -16509,9 +15135,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -16525,20 +15149,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -16587,16 +15205,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -16627,9 +15241,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -16659,9 +15271,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -16809,9 +15419,7 @@ paths:
nullable: true
type: string
global_data_tags:
- description: >-
- User defined data tags that are added to all of the
- inputs. The values can be strings or numbers.
+ description: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
items:
additionalProperties: false
type: object
@@ -16843,15 +15451,11 @@ paths:
is_preconfigured:
type: boolean
is_protected:
- description: >-
- Indicates whether the agent policy has tamper
- protection enabled. Default false.
+ description: Indicates whether the agent policy has tamper protection enabled. Default false.
type: boolean
keep_monitoring_alive:
default: false
- description: >-
- When set to true, monitoring will be enabled but
- logs/metrics collection will be disabled
+ description: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
nullable: true
type: boolean
monitoring_diagnostics:
@@ -16918,11 +15522,7 @@ paths:
type: string
overrides:
additionalProperties: {}
- description: >-
- 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.
+ description: 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.
nullable: true
type: object
package_policies:
@@ -16930,10 +15530,7 @@ paths:
- items:
type: string
type: array
- - description: >-
- This field is present only when retrieving a
- single agent policy, or when retrieving a list of
- agent policies with the ?full=true parameter
+ - description: This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
items:
additionalProperties: false
type: object
@@ -16979,9 +15576,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -17009,9 +15604,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -17064,9 +15657,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -17087,9 +15678,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -17103,20 +15692,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should
- be used only in unusual circumstances and
- not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -17165,16 +15748,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy
- will be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -17205,9 +15784,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -17237,9 +15814,7 @@ paths:
type: string
supports_agentless:
default: false
- description: >-
- Indicates whether the agent policy supports agentless
- integrations.
+ description: Indicates whether the agent policy supports agentless integrations.
nullable: true
type: boolean
unenroll_timeout:
@@ -17824,9 +16399,7 @@ paths:
agentPolicyId:
type: string
force:
- description: >-
- bypass validation checks that can prevent agent policy
- deletion
+ description: bypass validation checks that can prevent agent policy deletion
type: boolean
required:
- agentPolicyId
@@ -19864,9 +18437,7 @@ paths:
latestErrors:
items:
additionalProperties: false
- description: >-
- latest errors that happened when the agents
- executed the action
+ description: latest errors that happened when the agents executed the action
type: object
properties:
agentId:
@@ -20287,9 +18858,7 @@ paths:
description: Unenrolls hosted agents too
type: boolean
includeInactive:
- description: >-
- When passing agents by KQL query, unenrolls inactive agents
- too
+ description: When passing agents by KQL query, unenrolls inactive agents too
type: boolean
revoke:
description: Revokes API keys of agents
@@ -20614,10 +19183,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
additionalProperties: false
- description: >-
- A summary of the agent setup status. `isReady` indicates
- whether the setup is ready. If the setup is not ready,
- `missing_requirements` lists which requirements are missing.
+ description: A summary of the agent setup status. `isReady` indicates whether the setup is ready. If the setup is not ready, `missing_requirements` lists which requirements are missing.
type: object
properties:
is_secrets_storage_enabled:
@@ -20691,11 +19257,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
additionalProperties: false
- description: >-
- A summary of the result of Fleet's `setup` lifecycle. If
- `isInitialized` is true, Fleet is ready to accept agent
- enrollment. `nonFatalErrors` may include useful insight into
- non-blocking issues with Fleet setup.
+ description: A summary of the result of Fleet's `setup` lifecycle. If `isInitialized` is true, Fleet is ready to accept agent enrollment. `nonFatalErrors` may include useful insight into non-blocking issues with Fleet setup.
type: object
properties:
isInitialized:
@@ -20992,14 +19554,42 @@ paths:
type: object
properties:
active:
- description: >-
- When false, the enrollment API key is revoked and
- cannot be used for enrolling Elastic Agents.
+ description: When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.
+ type: boolean
+ api_key:
+ description: The enrollment API key (token) used for enrolling Elastic Agents.
+ type: string
+ api_key_id:
+ description: The ID of the API key in the Security API.
+ type: string
+ created_at:
+ type: string
+ id:
+ type: string
+ name:
+ description: The name of the enrollment API key.
+ type: string
+ policy_id:
+ description: The ID of the agent policy the Elastic Agent will be enrolled in.
+ type: string
+ required:
+ - id
+ - api_key_id
+ - api_key
+ - active
+ - created_at
+ type: array
+ list:
+ deprecated: true
+ items:
+ additionalProperties: false
+ type: object
+ properties:
+ active:
+ description: When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.
type: boolean
api_key:
- description: >-
- The enrollment API key (token) used for enrolling
- Elastic Agents.
+ description: The enrollment API key (token) used for enrolling Elastic Agents.
type: string
api_key_id:
description: The ID of the API key in the Security API.
@@ -21012,9 +19602,7 @@ paths:
description: The name of the enrollment API key.
type: string
policy_id:
- description: >-
- The ID of the agent policy the Elastic Agent will be
- enrolled in.
+ description: The ID of the agent policy the Elastic Agent will be enrolled in.
type: string
required:
- id
@@ -21034,6 +19622,7 @@ paths:
- total
- page
- perPage
+ - list
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -21103,14 +19692,10 @@ paths:
type: object
properties:
active:
- description: >-
- When false, the enrollment API key is revoked and
- cannot be used for enrolling Elastic Agents.
+ description: When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.
type: boolean
api_key:
- description: >-
- The enrollment API key (token) used for enrolling
- Elastic Agents.
+ description: The enrollment API key (token) used for enrolling Elastic Agents.
type: string
api_key_id:
description: The ID of the API key in the Security API.
@@ -21123,9 +19708,7 @@ paths:
description: The name of the enrollment API key.
type: string
policy_id:
- description: >-
- The ID of the agent policy the Elastic Agent will be
- enrolled in.
+ description: The ID of the agent policy the Elastic Agent will be enrolled in.
type: string
required:
- id
@@ -21243,14 +19826,10 @@ paths:
type: object
properties:
active:
- description: >-
- When false, the enrollment API key is revoked and
- cannot be used for enrolling Elastic Agents.
+ description: When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.
type: boolean
api_key:
- description: >-
- The enrollment API key (token) used for enrolling
- Elastic Agents.
+ description: The enrollment API key (token) used for enrolling Elastic Agents.
type: string
api_key_id:
description: The ID of the API key in the Security API.
@@ -21263,9 +19842,7 @@ paths:
description: The name of the enrollment API key.
type: string
policy_id:
- description: >-
- The ID of the agent policy the Elastic Agent will be
- enrolled in.
+ description: The ID of the agent policy the Elastic Agent will be enrolled in.
type: string
required:
- id
@@ -23606,7 +22183,7 @@ paths:
summary: Update package settings
tags:
- Elastic Package Manager (EPM)
- /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath*}:
+ /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath}:
get:
operationId: get-fleet-epm-packages-pkgname-pkgversion-filepath
parameters:
@@ -29413,9 +27990,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -29443,9 +28018,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -29498,9 +28071,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -29521,9 +28092,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -29536,9 +28105,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -29546,9 +28113,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -29573,15 +28138,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration
- documentation to know what streams are
- available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -29606,14 +28165,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -29622,20 +28176,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine
- procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -29684,16 +28232,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -29729,9 +28273,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -29755,9 +28297,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -29843,9 +28383,7 @@ paths:
enabled:
type: boolean
force:
- description: >-
- Force package policy creation even if package is not
- verified, or if the agent policy is managed.
+ description: Force package policy creation even if package is not verified, or if the agent policy is managed.
type: boolean
id:
description: Package policy unique identifier
@@ -29867,9 +28405,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -29897,9 +28433,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -29952,9 +28486,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -29975,9 +28507,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -29989,19 +28519,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit the
- agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -30055,9 +28580,7 @@ paths:
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
vars:
@@ -30072,9 +28595,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation for more
- information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- name
@@ -30102,9 +28623,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default to
- true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -30129,13 +28648,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation to
- know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -30160,13 +28675,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration documentation to
- know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
name:
type: string
@@ -30245,16 +28756,12 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
required:
- name
- package
- description: >-
- You should use inputs as an object and not use the deprecated
- inputs array.
+ description: You should use inputs as an object and not use the deprecated inputs array.
responses:
'200':
content:
@@ -30311,9 +28818,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -30341,9 +28846,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -30396,9 +28899,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -30419,9 +28920,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -30434,9 +28933,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -30444,9 +28941,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -30471,14 +28966,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation
- to know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -30503,13 +28993,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -30518,19 +29004,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -30579,16 +29060,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -30624,9 +29101,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -30650,9 +29125,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -30804,9 +29277,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -30834,9 +29305,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -30889,9 +29358,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -30912,9 +29379,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -30927,9 +29392,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -30937,9 +29400,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -30964,15 +29425,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration
- documentation to know what streams are
- available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -30997,14 +29452,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -31013,20 +29463,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine
- procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -31075,16 +29519,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -31120,9 +29560,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -31146,9 +29584,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -31338,9 +29774,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -31368,9 +29802,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -31423,9 +29855,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -31446,9 +29876,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -31461,9 +29889,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -31471,9 +29897,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -31498,14 +29922,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation
- to know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -31530,13 +29949,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -31545,19 +29960,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -31606,16 +30016,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -31651,9 +30057,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -31677,9 +30081,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -31790,9 +30192,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -31820,9 +30220,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -31875,9 +30273,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -31898,9 +30294,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -31911,19 +30305,14 @@ paths:
name:
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit the
- agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -31977,9 +30366,7 @@ paths:
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
vars:
@@ -31994,9 +30381,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation for more
- information)
+ description: Package variable (see integration documentation for more information)
type: object
version:
type: string
@@ -32023,9 +30408,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default to
- true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -32050,13 +30433,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation to
- know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -32081,13 +30460,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration documentation to
- know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
name:
type: string
@@ -32166,9 +30541,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
required:
- name
@@ -32229,9 +30602,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -32259,9 +30630,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -32314,9 +30683,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -32337,9 +30704,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -32352,9 +30717,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default to
- true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -32362,9 +30725,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -32389,14 +30750,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration documentation
- to know what streams are available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -32421,13 +30777,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -32436,19 +30788,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to inherit
- the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the package
- policy. The override option should be used only in
- unusual circumstances and not as a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -32497,16 +30844,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will be
- added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy will be
- added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -32542,9 +30885,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration documentation
- for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -32568,9 +30909,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see integration
- documentation for more information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -33037,9 +31376,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -33067,9 +31404,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -33122,9 +31457,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -33145,9 +31478,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -33160,9 +31491,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that input, (default
- to true)
+ description: enable or disable that input, (default to true)
type: boolean
streams:
additionalProperties:
@@ -33170,9 +31499,7 @@ paths:
type: object
properties:
enabled:
- description: >-
- enable or disable that stream, (default
- to true)
+ description: enable or disable that stream, (default to true)
type: boolean
vars:
additionalProperties:
@@ -33197,15 +31524,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Input streams (see integration
- documentation to know what streams are
- available)
+ description: Input streams (see integration documentation to know what streams are available)
type: object
vars:
additionalProperties:
@@ -33230,15 +31551,9 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
- description: >-
- Package policy inputs (see integration
- documentation to know what inputs are
- available)
+ description: Package policy inputs (see integration documentation to know what inputs are available)
type: object
x-oas-optional: true
is_managed:
@@ -33247,20 +31562,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should be
- used only in unusual circumstances and not as
- a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -33309,16 +31618,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will
- be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
revision:
@@ -33354,9 +31659,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
- additionalProperties:
anyOf:
@@ -33380,10 +31683,7 @@ paths:
- id
- isSecretRef
nullable: true
- description: >-
- Input/stream level variable (see
- integration documentation for more
- information)
+ description: Input/stream level variable (see integration documentation for more information)
type: object
x-oas-optional: true
version:
@@ -33438,9 +31738,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
enabled:
type: boolean
@@ -33468,9 +31766,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
data_stream:
additionalProperties: false
@@ -33523,9 +31819,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- enabled
@@ -33546,9 +31840,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- type
@@ -33565,20 +31857,14 @@ paths:
description: Package policy name (should be unique)
type: string
namespace:
- description: >-
- The package policy namespace. Leave blank to
- inherit the agent policy's namespace.
+ description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
type: string
output_id:
nullable: true
type: string
overrides:
additionalProperties: false
- description: >-
- Override settings that are defined in the
- package policy. The override option should be
- used only in unusual circumstances and not as
- a routine procedure.
+ description: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
nullable: true
type: object
properties:
@@ -33627,16 +31913,12 @@ paths:
- version
policy_id:
deprecated: true
- description: >-
- Agent policy ID where that package policy will
- be added
+ description: Agent policy ID where that package policy will be added
nullable: true
type: string
policy_ids:
items:
- description: >-
- Agent policy IDs where that package policy
- will be added
+ description: Agent policy IDs where that package policy will be added
type: string
type: array
vars:
@@ -33651,9 +31933,7 @@ paths:
value: {}
required:
- value
- description: >-
- Package variable (see integration
- documentation for more information)
+ description: Package variable (see integration documentation for more information)
type: object
required:
- name
@@ -34463,11 +32743,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
additionalProperties: false
- description: >-
- A summary of the result of Fleet's `setup` lifecycle. If
- `isInitialized` is true, Fleet is ready to accept agent
- enrollment. `nonFatalErrors` may include useful insight into
- non-blocking issues with Fleet setup.
+ description: A summary of the result of Fleet's `setup` lifecycle. If `isInitialized` is true, Fleet is ready to accept agent enrollment. `nonFatalErrors` may include useful insight into non-blocking issues with Fleet setup.
type: object
properties:
isInitialized:
@@ -34728,8 +33004,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -34781,8 +33056,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -34850,8 +33124,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -34926,8 +33199,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -34958,12 +33230,9 @@ paths:
tags:
- Security Lists API
put:
- description: >
- Update a list using the list ID. The original list is replaced, and all
- unspecified fields are deleted.
-
+ description: |
+ Update a list using the list ID. The original list is replaced, and all unspecified fields are deleted.
> info
-
> You cannot modify the `id` value.
operationId: UpdateList
requestBody:
@@ -35003,8 +33272,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35036,9 +33304,7 @@ paths:
- Security Lists API
/api/lists/_find:
get:
- description: >-
- Get a paginated subset of lists. By default, the first page is returned,
- with 20 results per page.
+ description: Get a paginated subset of lists. By default, the first page is returned, with 20 results per page.
operationId: FindLists
parameters:
- description: The page number to return
@@ -35068,24 +33334,17 @@ paths:
- desc
- asc
type: string
- - description: >
- Returns the list that come after the last list 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.
+ - description: |
+ Returns the list that come after the last list 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.
in: query
name: cursor
required: false
schema:
$ref: '#/components/schemas/Security_Lists_API_FindListsCursor'
- - description: >
- Filters the returned results according to the value of the specified
- field,
-
+ - description: |
+ Filters the returned results according to the value of the specified field,
using the : syntax.
in: query
name: filter
@@ -35126,8 +33385,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35172,8 +33430,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35226,8 +33483,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35277,8 +33533,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35331,9 +33586,7 @@ paths:
required: false
schema:
type: string
- - description: >-
- Determines when changes made by the request are made visible to
- search
+ - description: Determines when changes made by the request are made visible to search
in: query
name: refresh
required: false
@@ -35360,8 +33613,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35429,8 +33681,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35476,9 +33727,7 @@ paths:
meta:
$ref: '#/components/schemas/Security_Lists_API_ListItemMetadata'
refresh:
- description: >-
- Determines when changes made by the request are made visible
- to search
+ description: Determines when changes made by the request are made visible to search
enum:
- 'true'
- 'false'
@@ -35502,8 +33751,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35534,15 +33782,11 @@ paths:
tags:
- Security Lists API
post:
- description: >
+ description: |
Create a list item and associate it with the specified list.
-
- All list items in the same list must be the same type. For example, each
- list item in an `ip` list must define a specific IP address.
-
+ All list items in the same list must be the same type. For example, each list item in an `ip` list must define a specific IP address.
> info
-
> Before creating a list item, you must create a list.
operationId: CreateListItem
requestBody:
@@ -35558,9 +33802,7 @@ paths:
meta:
$ref: '#/components/schemas/Security_Lists_API_ListItemMetadata'
refresh:
- description: >-
- Determines when changes made by the request are made visible
- to search
+ description: Determines when changes made by the request are made visible to search
enum:
- 'true'
- 'false'
@@ -35585,8 +33827,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35617,12 +33858,9 @@ paths:
tags:
- Security Lists API
put:
- description: >
- Update a list item using the list item ID. The original list item is
- replaced, and all unspecified fields are deleted.
-
+ description: |
+ Update a list item using the list item ID. The original list item is replaced, and all unspecified fields are deleted.
> info
-
> You cannot modify the `id` value.
operationId: UpdateListItem
requestBody:
@@ -35656,8 +33894,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35712,8 +33949,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35781,24 +34017,17 @@ paths:
- desc
- asc
type: string
- - description: >
- Returns the list that come after the last list 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.
+ - description: |
+ Returns the list that come after the last list 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.
in: query
name: cursor
required: false
schema:
$ref: '#/components/schemas/Security_Lists_API_FindListItemsCursor'
- - description: >
- Filters the returned results according to the value of the specified
- field,
-
+ - description: |
+ Filters the returned results according to the value of the specified field,
using the : syntax.
in: query
name: filter
@@ -35813,8 +34042,7 @@ paths:
type: object
properties:
cursor:
- $ref: >-
- #/components/schemas/Security_Lists_API_FindListItemsCursor
+ $ref: '#/components/schemas/Security_Lists_API_FindListItemsCursor'
data:
items:
$ref: '#/components/schemas/Security_Lists_API_ListItem'
@@ -35840,8 +34068,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35867,10 +34094,8 @@ paths:
- Security Lists API
/api/lists/items/_import:
post:
- description: >
- Import list items from a TXT or CSV file. The maximum file size is 9
- million bytes.
-
+ description: |
+ Import list items from a TXT or CSV file. The maximum file size is 9 million bytes.
You can import items to a new or existing list.
operationId: ImportListItems
@@ -35884,12 +34109,10 @@ paths:
required: false
schema:
$ref: '#/components/schemas/Security_Lists_API_ListId'
- - description: >
+ - description: |
Type of the importing list.
-
- Required when importing a new list that is `list_id` is not
- specified.
+ Required when importing a new list that is `list_id` is not specified.
in: query
name: type
required: false
@@ -35905,9 +34128,7 @@ paths:
required: false
schema:
type: string
- - description: >-
- Determines when changes made by the request are made visible to
- search
+ - description: Determines when changes made by the request are made visible to search
in: query
name: refresh
required: false
@@ -35924,9 +34145,7 @@ paths:
type: object
properties:
file:
- description: >-
- A `.txt` or `.csv` file containing newline separated list
- items
+ description: A `.txt` or `.csv` file containing newline separated list items
format: binary
type: string
required: true
@@ -35942,8 +34161,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -35999,8 +34217,7 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Lists_API_PlatformErrorResponse
+ - $ref: '#/components/schemas/Security_Lists_API_PlatformErrorResponse'
- $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse'
description: Invalid input data response
'401':
@@ -36026,12 +34243,8 @@ paths:
- Security Lists API
/api/ml/saved_objects/sync:
get:
- description: >
- Synchronizes Kibana saved objects for machine learning jobs and trained
- models in the default space. You must have `all` privileges for the
- **Machine Learning** feature in the **Analytics** section of the Kibana
- feature privileges. This API runs automatically when you start Kibana
- and periodically thereafter.
+ description: |
+ Synchronizes Kibana saved objects for machine learning jobs and trained models in the default space. You must have `all` privileges for the **Machine Learning** feature in the **Analytics** section of the Kibana feature privileges. This API runs automatically when you start Kibana and periodically thereafter.
operationId: mlSync
parameters:
- $ref: '#/components/parameters/Machine_learning_APIs_simulateParam'
@@ -36095,7 +34308,6 @@ paths:
summary: Delete a note
tags:
- Security Timeline API
- - access:securitySolution
get:
description: Get all notes for a given document.
operationId: GetNotes
@@ -36159,7 +34371,6 @@ paths:
summary: Get notes
tags:
- Security Timeline API
- - access:securitySolution
patch:
description: Add a note to a Timeline or update an existing note.
operationId: PersistNoteRoute
@@ -36204,8 +34415,7 @@ paths:
type: object
properties:
persistNote:
- $ref: >-
- #/components/schemas/Security_Timeline_API_ResponseNote
+ $ref: '#/components/schemas/Security_Timeline_API_ResponseNote'
required:
- persistNote
required:
@@ -36214,7 +34424,6 @@ paths:
summary: Add or update a note
tags:
- Security Timeline API
- - access:securitySolution
/api/osquery/live_queries:
get:
description: Get a list of all live queries.
@@ -36224,15 +34433,13 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_FindLiveQueryRequestQuery
+ $ref: '#/components/schemas/Security_Osquery_API_FindLiveQueryRequestQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get live queries
tags:
@@ -36244,16 +34451,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_CreateLiveQueryRequestBody
+ $ref: '#/components/schemas/Security_Osquery_API_CreateLiveQueryRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Create a live query
tags:
@@ -36278,8 +34483,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get live query details
tags:
@@ -36303,15 +34507,13 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_GetLiveQueryResultsRequestQuery
+ $ref: '#/components/schemas/Security_Osquery_API_GetLiveQueryResultsRequestQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get live query results
tags:
@@ -36331,8 +34533,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get packs
tags:
@@ -36351,8 +34552,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Create a pack
tags:
@@ -36372,8 +34572,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Delete a pack
tags:
@@ -36392,8 +34591,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get pack details
tags:
@@ -36421,8 +34619,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Update a pack
tags:
@@ -36436,15 +34633,13 @@ paths:
name: query
required: true
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_FindSavedQueryRequestQuery
+ $ref: '#/components/schemas/Security_Osquery_API_FindSavedQueryRequestQuery'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get saved queries
tags:
@@ -36456,16 +34651,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_CreateSavedQueryRequestBody
+ $ref: '#/components/schemas/Security_Osquery_API_CreateSavedQueryRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Create a saved query
tags:
@@ -36485,8 +34678,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Delete a saved query
tags:
@@ -36505,8 +34697,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Get saved query details
tags:
@@ -36527,16 +34718,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_UpdateSavedQueryRequestBody
+ $ref: '#/components/schemas/Security_Osquery_API_UpdateSavedQueryRequestBody'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Osquery_API_DefaultSuccessResponse
+ $ref: '#/components/schemas/Security_Osquery_API_DefaultSuccessResponse'
description: OK
summary: Update a saved query
tags:
@@ -36574,8 +34763,7 @@ paths:
type: object
properties:
persistPinnedEventOnTimeline:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistPinnedEventResponse
+ $ref: '#/components/schemas/Security_Timeline_API_PersistPinnedEventResponse'
required:
- persistPinnedEventOnTimeline
required:
@@ -36584,12 +34772,9 @@ paths:
summary: Pin an event
tags:
- Security Timeline API
- - access:securitySolution
/api/risk_score/engine/dangerously_delete_data:
delete:
- description: >-
- Cleaning up the the Risk Engine by removing the indices, mapping and
- transforms
+ description: Cleaning up the the Risk Engine by removing the indices, mapping and transforms
operationId: CleanUpRiskEngine
responses:
'200':
@@ -36605,25 +34790,20 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_TaskManagerUnavailableResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_TaskManagerUnavailableResponse'
description: Task manager is unavailable
default:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_CleanUpRiskEngineErrorResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_CleanUpRiskEngineErrorResponse'
description: Unexpected error
summary: Cleanup the Risk Engine
tags:
- Security Entity Analytics API
/api/risk_score/engine/schedule_now:
post:
- description: >-
- Schedule the risk scoring engine to run as soon as possible. You can use
- this to recalculate entity risk scores after updating their asset
- criticality.
+ description: Schedule the risk scoring engine to run as soon as possible. You can use this to recalculate entity risk scores after updating their asset criticality.
operationId: ScheduleRiskEngineNow
requestBody:
content:
@@ -36633,22 +34813,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_RiskEngineScheduleNowResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_RiskEngineScheduleNowResponse'
description: Successful response
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_TaskManagerUnavailableResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_TaskManagerUnavailableResponse'
description: Task manager is unavailable
default:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_RiskEngineScheduleNowErrorResponse
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_RiskEngineScheduleNowErrorResponse'
description: Unexpected error
summary: Run the risk scoring engine
tags:
@@ -36696,19 +34873,8 @@ paths:
operationId: bulkDeleteSavedObjects
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
- - description: >
- When true, force delete objects that exist in multiple namespaces.
- Note that the option applies to the whole request. Use the delete
- object API to specify per-object deletion behavior. TIP: Use this if
- you attempted to delete objects and received an HTTP 400 error with
- the following message: "Unable to delete saved object that exists in
- multiple namespaces, use the force option to delete it anyway".
- WARNING: When you bulk delete objects that exist in multiple
- namespaces, the API also deletes legacy url aliases that reference
- the object. These requests are batched to minimise the impact but
- they can place a heavy load on Kibana. Make sure you limit the
- number of objects that exist in multiple namespaces in a single bulk
- delete operation.
+ - description: |
+ When true, force delete objects that exist in multiple namespaces. Note that the option applies to the whole request. Use the delete object API to specify per-object deletion behavior. TIP: Use this if you attempted to delete objects and received an HTTP 400 error with the following message: "Unable to delete saved object that exists in multiple namespaces, use the force option to delete it anyway". WARNING: When you bulk delete objects that exist in multiple namespaces, the API also deletes legacy url aliases that reference the object. These requests are batched to minimise the impact but they can place a heavy load on Kibana. Make sure you limit the number of objects that exist in multiple namespaces in a single bulk delete operation.
in: query
name: force
schema:
@@ -36727,10 +34893,8 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
type: object
- description: >
- Indicates a successful call. NOTE: This HTTP response code indicates
- that the bulk operation succeeded. Errors pertaining to individual
- objects will be returned in the response body.
+ description: |
+ Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -36773,14 +34937,8 @@ paths:
/api/saved_objects/_bulk_resolve:
post:
deprecated: true
- description: >
- Retrieve multiple Kibana saved objects by identifier using any legacy
- URL aliases if they exist. Under certain circumstances when Kibana is
- upgraded, saved object migrations may necessitate regenerating some
- object IDs to enable new features. When an object's ID is regenerated, a
- legacy URL alias is created for that object, preserving its old ID. In
- such a scenario, that object can be retrieved by the bulk resolve API
- using either its new ID or its old ID.
+ description: |
+ Retrieve multiple Kibana saved objects by identifier using any legacy URL aliases if they exist. Under certain circumstances when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that object can be retrieved by the bulk resolve API using either its new ID or its old ID.
operationId: bulkResolveSavedObjects
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
@@ -36798,10 +34956,8 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
type: object
- description: >
- Indicates a successful call. NOTE: This HTTP response code indicates
- that the bulk operation succeeded. Errors pertaining to individual
- objects will be returned in the response body.
+ description: |
+ Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -36832,10 +34988,8 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
schema:
type: object
- description: >
- Indicates a successful call. NOTE: This HTTP response code indicates
- that the bulk operation succeeded. Errors pertaining to individual
- objects will be returned in the response body.
+ description: |
+ Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -36847,24 +35001,15 @@ paths:
- saved objects
/api/saved_objects/_export:
post:
- description: >
+ description: |
Retrieve sets of saved objects that you want to import into Kibana.
-
You must include `type` or `objects` in the request body.
+ Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
- Exported saved objects are not backwards compatible and cannot be
- imported into an older version of Kibana.
-
-
- NOTE: The `savedObjects.maxImportExportSize` configuration setting
- limits the number of saved objects which may be exported.
+ NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.
-
- This functionality is in technical preview and may be changed or removed
- in a future release. Elastic will work to fix any issues, but features
- in technical preview are not subject to the support SLA of official GA
- features.
+ This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
operationId: exportSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
@@ -36882,9 +35027,7 @@ paths:
description: Do not add export details entry at the end of the stream.
type: boolean
includeReferencesDeep:
- description: >-
- Includes all of the referenced objects in the exported
- objects.
+ description: Includes all of the referenced objects in the exported objects.
type: boolean
objects:
description: A list of objects to export.
@@ -36892,9 +35035,7 @@ paths:
type: object
type: array
type:
- description: >-
- The saved object types to include in the export. Use `*` to
- export all the types.
+ description: The saved object types to include in the export. Use `*` to export all the types.
oneOf:
- type: string
- items:
@@ -36927,15 +35068,8 @@ paths:
description: Retrieve a paginated set of Kibana saved objects.
operationId: findSavedObjects
parameters:
- - description: >
- An aggregation structure, serialized as a string. The field format
- is similar to filter, meaning that to use a saved object type
- attribute in the aggregation, the `savedObjectType.attributes.title:
- "myTitle"` format must be used. For root fields, the syntax is
- `savedObjectType.rootField`. NOTE: As objects change in Kibana, the
- results on each page of the response also change. Use the find API
- for traditional paginated results, but avoid using it to export
- large amounts of data.
+ - description: |
+ An aggregation structure, serialized as a string. The field format is similar to filter, meaning that to use a saved object type attribute in the aggregation, the `savedObjectType.attributes.title: "myTitle"` format must be used. For root fields, the syntax is `savedObjectType.rootField`. NOTE: As objects change in Kibana, the results on each page of the response also change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.
in: query
name: aggs
schema:
@@ -36952,41 +35086,28 @@ paths:
oneOf:
- type: string
- type: array
- - description: >
- The filter is a KQL string with the caveat that if you filter with
- an attribute from your saved object type, it should look like that:
- `savedObjectType.attributes.title: "myTitle"`. However, if you use a
- root attribute of a saved object such as `updated_at`, you will have
- to define your filter like that: `savedObjectType.updated_at >
- 2018-12-22`.
+ - description: |
+ The filter is a KQL string with the caveat that if you filter with an attribute from your saved object type, it should look like that: `savedObjectType.attributes.title: "myTitle"`. However, if you use a root attribute of a saved object such as `updated_at`, you will have to define your filter like that: `savedObjectType.updated_at > 2018-12-22`.
in: query
name: filter
schema:
type: string
- - description: >-
- Filters to objects that do not have a relationship with the type and
- identifier combination.
+ - description: Filters to objects that do not have a relationship with the type and identifier combination.
in: query
name: has_no_reference
schema:
type: object
- - description: >-
- The operator to use for the `has_no_reference` parameter. Either
- `OR` or `AND`. Defaults to `OR`.
+ - description: The operator to use for the `has_no_reference` parameter. Either `OR` or `AND`. Defaults to `OR`.
in: query
name: has_no_reference_operator
schema:
type: string
- - description: >-
- Filters to objects that have a relationship with the type and ID
- combination.
+ - description: Filters to objects that have a relationship with the type and ID combination.
in: query
name: has_reference
schema:
type: object
- - description: >-
- The operator to use for the `has_reference` parameter. Either `OR`
- or `AND`. Defaults to `OR`.
+ - description: The operator to use for the `has_reference` parameter. Either `OR` or `AND`. Defaults to `OR`.
in: query
name: has_reference_operator
schema:
@@ -37001,30 +35122,20 @@ paths:
name: per_page
schema:
type: integer
- - description: >-
- An Elasticsearch `simple_query_string` query that filters the
- objects in the response.
+ - description: An Elasticsearch `simple_query_string` query that filters the objects in the response.
in: query
name: search
schema:
type: string
- - description: >-
- The fields to perform the `simple_query_string` parsed query
- against.
+ - description: The fields to perform the `simple_query_string` parsed query against.
in: query
name: search_fields
schema:
oneOf:
- type: string
- type: array
- - description: >
- Sorts the response. Includes "root" and "type" fields. "root" fields
- exist for all saved objects, such as "updated_at". "type" fields are
- specific to an object type, such as fields returned in the
- attributes key of the response. When a single type is defined in the
- type parameter, the "root" and "type" fields are allowed, and
- validity checks are made in that order. When multiple types are
- defined in the type parameter, only "root" fields are allowed.
+ - description: |
+ Sorts the response. Includes "root" and "type" fields. "root" fields exist for all saved objects, such as "updated_at". "type" fields are specific to an object type, such as fields returned in the attributes key of the response. When a single type is defined in the type parameter, the "root" and "type" fields are allowed, and validity checks are made in that order. When multiple types are defined in the type parameter, only "root" fields are allowed.
in: query
name: sort_field
schema:
@@ -37055,49 +35166,30 @@ paths:
- saved objects
/api/saved_objects/_import:
post:
- description: >
- Create sets of Kibana saved objects from a file created by the export
- API.
-
- Saved objects can be imported only into the same version, a newer minor
- on the same major, or the next major. Exported saved objects are not
- backwards compatible and cannot be imported into an older version of
- Kibana.
-
+ description: |
+ Create sets of Kibana saved objects from a file created by the export API.
+ Saved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
- This functionality is in technical preview and may be changed or removed
- in a future release. Elastic will work to fix any issues, but features
- in technical preview are not subject to the support SLA of official GA
- features.
+ This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
operationId: importSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
- - description: >
- 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.
+ - description: |
+ 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.
in: query
name: createNewCopies
required: false
schema:
type: boolean
- - description: >
- 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.
+ - description: |
+ 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.
in: query
name: overwrite
required: false
schema:
type: boolean
- - description: >
- 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.
+ - description: |
+ 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.
in: query
name: compatibilityMode
required: false
@@ -37113,13 +35205,8 @@ paths:
type: object
properties:
file:
- description: >
- A file exported using the export API. NOTE: The
- `savedObjects.maxImportExportSize` configuration setting
- limits the number of saved objects which may be included in
- this file. Similarly, the
- `savedObjects.maxImportPayloadBytes` setting limits the
- overall size of the file that can be imported.
+ description: |
+ A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
required: true
responses:
'200':
@@ -37132,38 +35219,25 @@ paths:
type: object
properties:
errors:
- description: >
- Indicates the import was unsuccessful and specifies the
- objects that failed to import.
-
+ description: |
+ Indicates the import was unsuccessful and specifies the objects that failed to import.
- NOTE: One object may result in multiple errors, which
- requires separate steps to resolve. For instance, a
- `missing_references` error and conflict error.
+ NOTE: One object may result in multiple errors, which requires separate steps to resolve. For instance, a `missing_references` error and conflict error.
items:
type: object
type: array
success:
- description: >
- Indicates when the import was successfully completed. When
- set to false, some objects may not have been created. For
- additional information, refer to the `errors` and
- `successResults` properties.
+ description: |
+ Indicates when the import was successfully completed. When set to false, some objects may not have been created. For additional information, refer to the `errors` and `successResults` properties.
type: boolean
successCount:
description: Indicates the number of successfully imported records.
type: integer
successResults:
- description: >
- Indicates the objects that are successfully imported, with
- any metadata if applicable.
-
+ description: |
+ Indicates the objects that are successfully imported, with any metadata if applicable.
- NOTE: Objects are created only when all resolvable errors
- are addressed, including conflicts and missing references.
- If objects are created as new copies, each entry in the
- `successResults` array includes a `destinationId`
- attribute.
+ NOTE: Objects are created only when all resolvable errors are addressed, including conflicts and missing references. If objects are created as new copies, each entry in the `successResults` array includes a `destinationId` attribute.
items:
type: object
type: array
@@ -37187,39 +35261,26 @@ paths:
--form file=@file.ndjson
/api/saved_objects/_resolve_import_errors:
post:
- description: >
+ description: |
To resolve errors from the Import objects API, you can:
-
* Retry certain saved objects
-
* Overwrite specific saved objects
-
* Change references to different saved objects
-
- This functionality is in technical preview and may be changed or removed
- in a future release. Elastic will work to fix any issues, but features
- in technical preview are not subject to the support SLA of official GA
- features.
+ This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
operationId: resolveImportErrors
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
- - description: >
- Applies various adjustments to the saved objects that are being
- imported to maintain compatibility between different Kibana
- versions. When enabled during the initial import, also enable when
- resolving import errors. This option cannot be used with the
- `createNewCopies` option.
+ - description: |
+ Applies various adjustments to the saved objects that are being imported to maintain compatibility between different Kibana versions. When enabled during the initial import, also enable when resolving import errors. This option cannot be used with the `createNewCopies` option.
in: query
name: compatibilityMode
required: false
schema:
type: boolean
- - description: >
- Creates copies of the saved objects, regenerates each object ID, and
- resets the origin. When enabled during the initial import, also
- enable when resolving import errors.
+ - description: |
+ Creates copies of the saved objects, regenerates each object ID, and resets the origin. When enabled during the initial import, also enable when resolving import errors.
in: query
name: createNewCopies
required: false
@@ -37230,8 +35291,7 @@ paths:
multipart/form-data; Elastic-Api-Version=2023-10-31:
examples:
resolveImportErrorsRequest:
- $ref: >-
- #/components/examples/Saved_objects_resolve_missing_reference_request
+ $ref: '#/components/examples/Saved_objects_resolve_missing_reference_request'
schema:
type: object
properties:
@@ -37240,35 +35300,24 @@ paths:
format: binary
type: string
retries:
- description: >-
- The retry operations, which can specify how to resolve
- different types of errors.
+ description: The retry operations, which can specify how to resolve different types of errors.
items:
type: object
properties:
destinationId:
- description: >-
- Specifies the destination ID that the imported object
- should have, if different from the current ID.
+ description: Specifies the destination ID that the imported object should have, if different from the current ID.
type: string
id:
description: The saved object ID.
type: string
ignoreMissingReferences:
- description: >-
- When set to `true`, ignores missing reference errors.
- When set to `false`, does nothing.
+ description: When set to `true`, ignores missing reference errors. When set to `false`, does nothing.
type: boolean
overwrite:
- description: >-
- When set to `true`, the source object overwrites the
- conflicting destination object. When set to `false`,
- does nothing.
+ description: When set to `true`, the source object overwrites the conflicting destination object. When set to `false`, does nothing.
type: boolean
replaceReferences:
- description: >-
- A list of `type`, `from`, and `to` used to change the
- object references.
+ description: A list of `type`, `from`, and `to` used to change the object references.
items:
type: object
properties:
@@ -37295,41 +35344,31 @@ paths:
application/json; Elastic-Api-Version=2023-10-31:
examples:
resolveImportErrorsResponse:
- $ref: >-
- #/components/examples/Saved_objects_resolve_missing_reference_response
+ $ref: '#/components/examples/Saved_objects_resolve_missing_reference_response'
schema:
type: object
properties:
errors:
- description: >
+ description: |
Specifies the objects that failed to resolve.
-
- NOTE: One object can result in multiple errors, which
- requires separate steps to resolve. For instance, a
- `missing_references` error and a `conflict` error.
+ NOTE: One object can result in multiple errors, which requires separate steps to resolve. For instance, a `missing_references` error and a `conflict` error.
items:
type: object
type: array
success:
- description: >
- Indicates a successful import. When set to `false`, some
- objects may not have been created. For additional
- information, refer to the `errors` and `successResults`
- properties.
+ description: |
+ Indicates a successful import. When set to `false`, some objects may not have been created. For additional information, refer to the `errors` and `successResults` properties.
type: boolean
successCount:
description: |
Indicates the number of successfully resolved records.
type: number
successResults:
- description: >
- Indicates the objects that are successfully imported, with
- any metadata if applicable.
-
+ description: |
+ Indicates the objects that are successfully imported, with any metadata if applicable.
- NOTE: Objects are only created when all resolvable errors
- are addressed, including conflict and missing references.
+ NOTE: Objects are only created when all resolvable errors are addressed, including conflict and missing references.
items:
type: object
type: array
@@ -37413,9 +35452,7 @@ paths:
- saved objects
post:
deprecated: true
- description: >-
- Create a Kibana saved object and specify its identifier instead of using
- a randomly generated ID.
+ description: Create a Kibana saved object and specify its identifier instead of using a randomly generated ID.
operationId: createSavedObjectId
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
@@ -37496,14 +35533,8 @@ paths:
/api/saved_objects/resolve/{type}/{id}:
get:
deprecated: true
- description: >
- Retrieve a single Kibana saved object by identifier using any legacy URL
- alias if it exists. Under certain circumstances, when Kibana is
- upgraded, saved object migrations may necessitate regenerating some
- object IDs to enable new features. When an object's ID is regenerated, a
- legacy URL alias is created for that object, preserving its old ID. In
- such a scenario, that object can be retrieved using either its new ID or
- its old ID.
+ description: |
+ Retrieve a single Kibana saved object by identifier using any legacy URL alias if it exists. Under certain circumstances, when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that object can be retrieved using either its new ID or its old ID.
operationId: resolveSavedObject
parameters:
- $ref: '#/components/parameters/Saved_objects_saved_object_id'
@@ -37526,10 +35557,7 @@ paths:
- saved objects
/api/security_ai_assistant/anonymization_fields/_bulk_action:
post:
- description: >-
- Apply a bulk action to multiple anonymization fields. The bulk action is
- applied to all anonymization fields that match the filter or to the list
- of anonymization fields by their IDs.
+ description: Apply a bulk action to multiple anonymization fields. The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs.
operationId: PerformAnonymizationFieldsBulkAction
requestBody:
content:
@@ -37539,8 +35567,7 @@ paths:
properties:
create:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldCreateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldCreateProps'
type: array
delete:
type: object
@@ -37556,16 +35583,14 @@ paths:
type: string
update:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldUpdateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldUpdateProps'
type: array
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResponse'
description: Indicates a successful call.
'400':
content:
@@ -37583,7 +35608,6 @@ paths:
summary: Apply a bulk action to anonymization fields
tags:
- Security AI Assistant API
- - Bulk API
/api/security_ai_assistant/anonymization_fields/_find:
get:
description: Get a list of all anonymization fields.
@@ -37607,8 +35631,7 @@ paths:
name: sort_field
required: false
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_FindAnonymizationFieldsSortField
+ $ref: '#/components/schemas/Security_AI_Assistant_API_FindAnonymizationFieldsSortField'
- description: Sort order
in: query
name: sort_order
@@ -37640,8 +35663,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse'
type: array
page:
type: integer
@@ -37671,7 +35693,6 @@ paths:
summary: Get anonymization fields
tags:
- Security AI Assistant API
- - AnonymizationFields API
/api/security_ai_assistant/chat/complete:
post:
description: Create a model response for the given chat conversation.
@@ -37706,7 +35727,6 @@ paths:
summary: Create a model response
tags:
- Security AI Assistant API
- - Chat Complete API
/api/security_ai_assistant/current_user/conversations:
post:
description: Create a new Security AI Assistant conversation.
@@ -37715,16 +35735,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationCreateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationCreateProps'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
description: Indicates a successful call.
'400':
content:
@@ -37742,7 +35760,6 @@ paths:
summary: Create a conversation
tags:
- Security AI Assistant API
- - Conversation API
/api/security_ai_assistant/current_user/conversations/_find:
get:
description: Get a list of all conversations for the current user.
@@ -37766,8 +35783,7 @@ paths:
name: sort_field
required: false
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_FindConversationsSortField
+ $ref: '#/components/schemas/Security_AI_Assistant_API_FindConversationsSortField'
- description: Sort order
in: query
name: sort_order
@@ -37799,8 +35815,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
type: array
page:
type: integer
@@ -37830,7 +35845,6 @@ paths:
summary: Get conversations
tags:
- Security AI Assistant API
- - Conversations API
/api/security_ai_assistant/current_user/conversations/{id}:
delete:
description: Delete an existing conversation using the conversation ID.
@@ -37847,8 +35861,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
description: Indicates a successful call.
'400':
content:
@@ -37866,7 +35879,6 @@ paths:
summary: Delete a conversation
tags:
- Security AI Assistant API
- - Conversation API
get:
description: Get the details of an existing conversation using the conversation ID.
operationId: ReadConversation
@@ -37882,8 +35894,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
description: Indicates a successful call.
'400':
content:
@@ -37901,7 +35912,6 @@ paths:
summary: Get a conversation
tags:
- Security AI Assistant API
- - Conversations API
put:
description: Update an existing conversation using the conversation ID.
operationId: UpdateConversation
@@ -37916,16 +35926,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationUpdateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationUpdateProps'
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationResponse'
description: Indicates a successful call.
'400':
content:
@@ -37943,13 +35951,9 @@ paths:
summary: Update a conversation
tags:
- Security AI Assistant API
- - Conversation API
/api/security_ai_assistant/prompts/_bulk_action:
post:
- description: >-
- Apply a bulk action to multiple prompts. The bulk action is applied to
- all prompts that match the filter or to the list of prompts by their
- IDs.
+ description: Apply a bulk action to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs.
operationId: PerformPromptsBulkAction
requestBody:
content:
@@ -37959,8 +35963,7 @@ paths:
properties:
create:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptCreateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptCreateProps'
type: array
delete:
type: object
@@ -37976,16 +35979,14 @@ paths:
type: string
update:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptUpdateProps
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptUpdateProps'
type: array
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptsBulkCrudActionResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptsBulkCrudActionResponse'
description: Indicates a successful call.
'400':
content:
@@ -38003,7 +36004,6 @@ paths:
summary: Apply a bulk action to prompts
tags:
- Security AI Assistant API
- - Bulk API
/api/security_ai_assistant/prompts/_find:
get:
description: Get a list of all prompts.
@@ -38027,8 +36027,7 @@ paths:
name: sort_field
required: false
schema:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_FindPromptsSortField
+ $ref: '#/components/schemas/Security_AI_Assistant_API_FindPromptsSortField'
- description: Sort order
in: query
name: sort_order
@@ -38060,8 +36059,7 @@ paths:
properties:
data:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptResponse'
type: array
page:
type: integer
@@ -38091,7 +36089,6 @@ paths:
summary: Get prompts
tags:
- Security AI Assistant API
- - Prompts API
/api/security/role:
get:
operationId: get-security-role
@@ -38104,10 +36101,7 @@ paths:
enum:
- '2023-10-31'
type: string
- - description: >-
- 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.
+ - description: 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.
in: query
name: replaceDeprecatedPrivileges
required: false
@@ -38116,6 +36110,11 @@ paths:
responses:
'200':
description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getRolesResponse1:
+ $ref: '#/components/examples/get_roles_response1'
summary: Get all roles
tags:
- roles
@@ -38168,10 +36167,7 @@ paths:
schema:
minLength: 1
type: string
- - description: >-
- 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.
+ - description: 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.
in: query
name: replaceDeprecatedPrivileges
required: false
@@ -38180,13 +36176,16 @@ paths:
responses:
'200':
description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getRoleResponse1:
+ $ref: '#/components/examples/get_role_response1'
summary: Get a role
tags:
- roles
put:
- description: >-
- Create a new Kibana role or update the attributes of an existing role.
- Kibana roles are stored in the Elasticsearch native realm.
+ description: Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm.
operationId: put-security-role-name
parameters:
- description: The version of the API to use
@@ -38236,9 +36235,7 @@ paths:
properties:
cluster:
items:
- description: >-
- Cluster privileges that define the cluster level
- actions that users can perform.
+ description: Cluster privileges that define the cluster level actions that users can perform.
type: string
type: array
indices:
@@ -38247,55 +36244,29 @@ paths:
type: object
properties:
allow_restricted_indices:
- description: >-
- Restricted indices are a special category of
- indices that are used internally to store
- configuration data and should not be directly
- accessed. Only internal system roles should
- normally grant privileges over the restricted
- indices. Toggling this flag is very strongly
- discouraged because it could effectively grant
- unrestricted operations on critical data, making
- the entire system unstable or leaking sensitive
- information. If for administrative purposes you
- need to create a role with privileges covering
- restricted indices, however, you can set this
- property to true. In that case, the names field
- covers the restricted indices too.
+ description: Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field covers the restricted indices too.
type: boolean
field_security:
additionalProperties:
items:
- description: >-
- The document fields that the role members have
- read access to.
+ description: The document fields that the role members have read access to.
type: string
type: array
type: object
names:
items:
- description: >-
- The data streams, indices, and aliases to which
- the permissions in this entry apply. It supports
- wildcards (*).
+ description: The data streams, indices, and aliases to which the permissions in this entry apply. It supports wildcards (*).
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The index level privileges that the role members
- have for the data streams and indices.
+ description: The index level privileges that the role members have for the data streams and indices.
type: string
minItems: 1
type: array
query:
- description: >-
- A search query that defines the documents the role
- members have read access to. A document within the
- specified data streams and indices must match this
- query in order for it to be accessible by the role
- members.
+ description: A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members.
type: string
required:
- names
@@ -38308,19 +36279,13 @@ paths:
properties:
clusters:
items:
- description: >-
- A list of remote cluster aliases. It supports
- literal strings as well as wildcards and regular
- expressions.
+ description: A list of remote cluster aliases. It supports literal strings as well as wildcards and regular expressions.
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The cluster level privileges for the remote
- cluster. The allowed values are a subset of the
- cluster privileges.
+ description: The cluster level privileges for the remote cluster. The allowed values are a subset of the cluster privileges.
type: string
minItems: 1
type: array
@@ -38334,64 +36299,35 @@ paths:
type: object
properties:
allow_restricted_indices:
- description: >-
- Restricted indices are a special category of
- indices that are used internally to store
- configuration data and should not be directly
- accessed. Only internal system roles should
- normally grant privileges over the restricted
- indices. Toggling this flag is very strongly
- discouraged because it could effectively grant
- unrestricted operations on critical data, making
- the entire system unstable or leaking sensitive
- information. If for administrative purposes you
- need to create a role with privileges covering
- restricted indices, however, you can set this
- property to true. In that case, the names field
- will cover the restricted indices too.
+ description: Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field will cover the restricted indices too.
type: boolean
clusters:
items:
- description: >-
- A list of remote cluster aliases. It supports
- literal strings as well as wildcards and regular
- expressions.
+ description: A list of remote cluster aliases. It supports literal strings as well as wildcards and regular expressions.
type: string
minItems: 1
type: array
field_security:
additionalProperties:
items:
- description: >-
- The document fields that the role members have
- read access to.
+ description: The document fields that the role members have read access to.
type: string
type: array
type: object
names:
items:
- description: >-
- A list of remote aliases, data streams, or
- indices to which the permissions apply. It
- supports wildcards (*).
+ description: A list of remote aliases, data streams, or indices to which the permissions apply. It supports wildcards (*).
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The index level privileges that role members
- have for the specified indices.
+ description: The index level privileges that role members have for the specified indices.
type: string
minItems: 1
type: array
query:
- description: >-
- A search query that defines the documents the role
- members have read access to. A document within the
- specified data streams and indices must match this
- query in order for it to be accessible by the role
- members.
+ description: 'A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members. '
type: string
required:
- clusters
@@ -38419,23 +36355,17 @@ paths:
nullable: true
oneOf:
- items:
- description: >-
- A base privilege that grants applies to all
- spaces.
+ description: A base privilege that grants applies to all spaces.
type: string
type: array
- items:
- description: >-
- A base privilege that applies to specific
- spaces.
+ description: A base privilege that applies to specific spaces.
type: string
type: array
feature:
additionalProperties:
items:
- description: >-
- The privileges that the role member has for the
- feature.
+ description: The privileges that the role member has for the feature.
type: string
type: array
type: object
@@ -38462,6 +36392,15 @@ paths:
type: object
required:
- elasticsearch
+ examples:
+ createRoleRequest1:
+ $ref: '#/components/examples/create_role_request1'
+ createRoleRequest2:
+ $ref: '#/components/examples/create_role_request2'
+ createRoleRequest3:
+ $ref: '#/components/examples/create_role_request3'
+ createRoleRequest4:
+ $ref: '#/components/examples/create_role_request4'
responses:
'204':
description: Indicates a successful call.
@@ -38509,9 +36448,7 @@ paths:
properties:
cluster:
items:
- description: >-
- Cluster privileges that define the cluster level
- actions that users can perform.
+ description: Cluster privileges that define the cluster level actions that users can perform.
type: string
type: array
indices:
@@ -38520,58 +36457,29 @@ paths:
type: object
properties:
allow_restricted_indices:
- description: >-
- Restricted indices are a special category of
- indices that are used internally to store
- configuration data and should not be
- directly accessed. Only internal system
- roles should normally grant privileges over
- the restricted indices. Toggling this flag
- is very strongly discouraged because it
- could effectively grant unrestricted
- operations on critical data, making the
- entire system unstable or leaking sensitive
- information. If for administrative purposes
- you need to create a role with privileges
- covering restricted indices, however, you
- can set this property to true. In that case,
- the names field covers the restricted
- indices too.
+ description: Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field covers the restricted indices too.
type: boolean
field_security:
additionalProperties:
items:
- description: >-
- The document fields that the role
- members have read access to.
+ description: The document fields that the role members have read access to.
type: string
type: array
type: object
names:
items:
- description: >-
- The data streams, indices, and aliases to
- which the permissions in this entry apply.
- It supports wildcards (*).
+ description: The data streams, indices, and aliases to which the permissions in this entry apply. It supports wildcards (*).
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The index level privileges that the role
- members have for the data streams and
- indices.
+ description: The index level privileges that the role members have for the data streams and indices.
type: string
minItems: 1
type: array
query:
- description: >-
- A search query that defines the documents
- the role members have read access to. A
- document within the specified data streams
- and indices must match this query in order
- for it to be accessible by the role members.
+ description: A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members.
type: string
required:
- names
@@ -38584,19 +36492,13 @@ paths:
properties:
clusters:
items:
- description: >-
- A list of remote cluster aliases. It
- supports literal strings as well as
- wildcards and regular expressions.
+ description: A list of remote cluster aliases. It supports literal strings as well as wildcards and regular expressions.
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The cluster level privileges for the
- remote cluster. The allowed values are a
- subset of the cluster privileges.
+ description: The cluster level privileges for the remote cluster. The allowed values are a subset of the cluster privileges.
type: string
minItems: 1
type: array
@@ -38610,67 +36512,35 @@ paths:
type: object
properties:
allow_restricted_indices:
- description: >-
- Restricted indices are a special category of
- indices that are used internally to store
- configuration data and should not be
- directly accessed. Only internal system
- roles should normally grant privileges over
- the restricted indices. Toggling this flag
- is very strongly discouraged because it
- could effectively grant unrestricted
- operations on critical data, making the
- entire system unstable or leaking sensitive
- information. If for administrative purposes
- you need to create a role with privileges
- covering restricted indices, however, you
- can set this property to true. In that case,
- the names field will cover the restricted
- indices too.
+ description: Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field will cover the restricted indices too.
type: boolean
clusters:
items:
- description: >-
- A list of remote cluster aliases. It
- supports literal strings as well as
- wildcards and regular expressions.
+ description: A list of remote cluster aliases. It supports literal strings as well as wildcards and regular expressions.
type: string
minItems: 1
type: array
field_security:
additionalProperties:
items:
- description: >-
- The document fields that the role
- members have read access to.
+ description: The document fields that the role members have read access to.
type: string
type: array
type: object
names:
items:
- description: >-
- A list of remote aliases, data streams, or
- indices to which the permissions apply. It
- supports wildcards (*).
+ description: A list of remote aliases, data streams, or indices to which the permissions apply. It supports wildcards (*).
type: string
minItems: 1
type: array
privileges:
items:
- description: >-
- The index level privileges that role
- members have for the specified indices.
+ description: The index level privileges that role members have for the specified indices.
type: string
minItems: 1
type: array
query:
- description: >-
- A search query that defines the documents
- the role members have read access to. A
- document within the specified data streams
- and indices must match this query in order
- for it to be accessible by the role
- members.
+ description: 'A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members. '
type: string
required:
- clusters
@@ -38679,9 +36549,7 @@ paths:
type: array
run_as:
items:
- description: >-
- A user name that the role member can
- impersonate.
+ description: A user name that the role member can impersonate.
type: string
type: array
kibana:
@@ -38700,23 +36568,17 @@ paths:
nullable: true
oneOf:
- items:
- description: >-
- A base privilege that grants applies to
- all spaces.
+ description: A base privilege that grants applies to all spaces.
type: string
type: array
- items:
- description: >-
- A base privilege that applies to specific
- spaces.
+ description: A base privilege that applies to specific spaces.
type: string
type: array
feature:
additionalProperties:
items:
- description: >-
- The privileges that the role member has for
- the feature.
+ description: The privileges that the role member has for the feature.
type: string
type: array
type: object
@@ -38754,15 +36616,7 @@ paths:
- roles
/api/spaces/_copy_saved_objects:
post:
- description: >-
- It also allows you to automatically copy related objects, so when you
- copy a dashboard, this can automatically copy over the associated
- visualizations, data views, and saved searches, as required. You can
- request to overwrite any objects that already exist in the target space
- if they share an identifier or you can use the resolve copy saved
- objects conflicts API to do this on a per-object
- basis.
[Required authorization] Route required privileges: ALL
- of [copySavedObjectsToSpaces].
+ description: 'It also allows you to automatically copy related objects, so when you copy a dashboard, this can automatically copy over the associated visualizations, data views, and saved searches, as required. You can request to overwrite any objects that already exist in the target space if they share an identifier or you can use the resolve copy saved objects conflicts API to do this on a per-object basis.
[Required authorization] Route required privileges: ALL of [copySavedObjectsToSpaces].'
operationId: post-spaces-copy-saved-objects
parameters:
- description: The version of the API to use
@@ -38789,26 +36643,15 @@ paths:
properties:
compatibilityMode:
default: false
- description: >-
- Apply various adjustments to the saved objects that are
- being copied to maintain compatibility between different
- Kibana versions. Use this option only if you encounter
- issues with copied saved objects. This option cannot be used
- with the `createNewCopies` option.
+ description: Apply various adjustments to the saved objects that are being copied to maintain compatibility between different Kibana versions. Use this option only if you encounter issues with copied saved objects. This option cannot be used with the `createNewCopies` option.
type: boolean
createNewCopies:
default: true
- description: >-
- Create new copies of saved objects, regenerate each object
- identifier, and reset the origin. When used, potential
- conflict errors are avoided. This option cannot be used
- with the `overwrite` and `compatibilityMode` options.
+ description: Create new copies of saved objects, regenerate each object identifier, and reset the origin. When used, potential conflict errors are avoided. This option cannot be used with the `overwrite` and `compatibilityMode` options.
type: boolean
includeReferences:
default: false
- description: >-
- When set to true, all saved objects related to the specified
- saved objects will also be copied into the target spaces.
+ description: When set to true, all saved objects related to the specified saved objects will also be copied into the target spaces.
type: boolean
objects:
items:
@@ -38827,24 +36670,34 @@ paths:
type: array
overwrite:
default: false
- description: >-
- When set to true, all conflicts are automatically
- overridden. When a saved object with a matching type and
- identifier exists in the target space, that version is
- replaced with the version from the source space. This option
- cannot be used with the `createNewCopies` option.
+ description: When set to true, all conflicts are automatically overridden. When a saved object with a matching type and identifier exists in the target space, that version is replaced with the version from the source space. This option cannot be used with the `createNewCopies` option.
type: boolean
spaces:
items:
- description: >-
- The identifiers of the spaces where you want to copy the
- specified objects.
+ description: The identifiers of the spaces where you want to copy the specified objects.
type: string
type: array
required:
- spaces
- objects
- responses: {}
+ examples:
+ copySavedObjectsRequestExample1:
+ $ref: '#/components/examples/copy_saved_objects_request1'
+ copySavedObjectsRequestExample2:
+ $ref: '#/components/examples/copy_saved_objects_request2'
+ responses:
+ '200':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ copySavedObjectsResponseExample1:
+ $ref: '#/components/examples/copy_saved_objects_response1'
+ copySavedObjectsResponseExample2:
+ $ref: '#/components/examples/copy_saved_objects_response2'
+ copySavedObjectsResponseExample3:
+ $ref: '#/components/examples/copy_saved_objects_response3'
+ copySavedObjectsResponseExample4:
+ $ref: '#/components/examples/copy_saved_objects_response4'
summary: Copy saved objects between spaces
tags:
- spaces
@@ -38880,9 +36733,7 @@ paths:
type: object
properties:
sourceId:
- description: >-
- The alias source object identifier. This is the legacy
- object identifier.
+ description: The alias source object identifier. This is the legacy object identifier.
type: string
targetSpace:
description: The space where the alias target object exists.
@@ -38897,6 +36748,9 @@ paths:
type: array
required:
- aliases
+ examples:
+ disableLegacyURLRequestExample1:
+ $ref: '#/components/examples/disable_legacy_url_request1'
responses: {}
summary: Disable legacy URL aliases
tags:
@@ -38949,10 +36803,7 @@ paths:
- spaces
/api/spaces/_resolve_copy_saved_objects_errors:
post:
- description: >-
- Overwrite saved objects that are returned as errors from the copy saved
- objects to space API.
[Required authorization] Route required
- privileges: ALL of [copySavedObjectsToSpaces].
+ description: 'Overwrite saved objects that are returned as errors from the copy saved objects to space API.
[Required authorization] Route required privileges: ALL of [copySavedObjectsToSpaces].'
operationId: post-spaces-resolve-copy-saved-objects-errors
parameters:
- description: The version of the API to use
@@ -39006,30 +36857,20 @@ paths:
type: object
properties:
createNewCopy:
- description: >-
- Creates new copies of the saved objects, regenerates
- each object ID, and resets the origin.
+ description: Creates new copies of the saved objects, regenerates each object ID, and resets the origin.
type: boolean
destinationId:
- description: >-
- Specifies the destination identifier that the copied
- object should have, if different from the current
- identifier.
+ description: Specifies the destination identifier that the copied object should have, if different from the current identifier.
type: string
id:
description: The saved object identifier.
type: string
ignoreMissingReferences:
- description: >-
- When set to true, any missing references errors are
- ignored.
+ description: When set to true, any missing references errors are ignored.
type: boolean
overwrite:
default: false
- description: >-
- When set to true, the saved object from the source
- space overwrites the conflicting object in the
- destination space.
+ description: When set to true, the saved object from the source space overwrites the conflicting object in the destination space.
type: boolean
type:
description: The saved object type.
@@ -39042,7 +36883,20 @@ paths:
required:
- retries
- objects
- responses: {}
+ examples:
+ resolveCopySavedObjectsRequestExample1:
+ $ref: '#/components/examples/resolve_copy_saved_objects_request1'
+ resolveCopySavedObjectsRequestExample2:
+ $ref: '#/components/examples/resolve_copy_saved_objects_request2'
+ responses:
+ '200':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ resolveCopySavedObjectsResponseExample1:
+ $ref: '#/components/examples/copy_saved_objects_response1'
+ resolveCopySavedObjectsResponseExample2:
+ $ref: '#/components/examples/copy_saved_objects_response2'
summary: Resolve conflicts copying saved objects
tags: []
/api/spaces/_update_objects_spaces:
@@ -39089,23 +36943,28 @@ paths:
type: array
spacesToAdd:
items:
- description: >-
- The identifiers of the spaces the saved objects should be
- added to or removed from.
+ description: The identifiers of the spaces the saved objects should be added to or removed from.
type: string
type: array
spacesToRemove:
items:
- description: >-
- The identifiers of the spaces the saved objects should be
- added to or removed from.
+ description: The identifiers of the spaces the saved objects should be added to or removed from.
type: string
type: array
required:
- objects
- spacesToAdd
- spacesToRemove
- responses: {}
+ examples:
+ updateObjectSpacesRequestExample1:
+ $ref: '#/components/examples/update_saved_objects_spaces_request1'
+ responses:
+ '200':
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ updateObjectSpacesResponseExample1:
+ $ref: '#/components/examples/update_saved_objects_spaces_response1'
summary: Update saved objects in spaces
tags:
- spaces
@@ -39121,9 +36980,7 @@ paths:
enum:
- '2023-10-31'
type: string
- - description: >-
- Specifies which authorization checks are applied to the API call.
- The default value is `any`.
+ - description: Specifies which authorization checks are applied to the API call. The default value is `any`.
in: query
name: purpose
required: false
@@ -39133,14 +36990,7 @@ paths:
- copySavedObjectsIntoSpace
- shareSavedObjectsIntoSpace
type: string
- - description: >-
- 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.
+ - description: 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.
in: query
name: include_authorized_purposes
required: true
@@ -39163,6 +37013,13 @@ paths:
responses:
'200':
description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getSpacesResponseExample1:
+ $ref: '#/components/examples/get_spaces_response1'
+ getSpacesResponseExample2:
+ $ref: '#/components/examples/get_spaces_response2'
summary: Get all spaces
tags:
- spaces
@@ -39194,10 +37051,7 @@ paths:
_reserved:
type: boolean
color:
- description: >-
- The hexadecimal color code used in the space avatar. By
- default, the color is automatically generated from the space
- name.
+ description: The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
type: string
description:
description: A description for the space.
@@ -39209,26 +37063,13 @@ paths:
type: string
type: array
id:
- description: >-
- 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.
+ description: 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.
type: string
imageUrl:
- description: >-
- 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.
+ description: 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.
type: string
initials:
- description: >-
- One or two characters that are shown in the space avatar. By
- default, the initials are automatically generated from the
- space name.
+ description: One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.
maxLength: 2
type: string
name:
@@ -39245,6 +37086,9 @@ paths:
required:
- id
- name
+ examples:
+ createSpaceRequest:
+ $ref: '#/components/examples/create_space_request'
responses:
'200':
description: Indicates a successful call.
@@ -39253,9 +37097,7 @@ paths:
- spaces
/api/spaces/space/{id}:
delete:
- description: >-
- When you delete a space, all saved objects that belong to the space are
- automatically deleted, which is permanent and cannot be undone.
+ description: When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone.
operationId: delete-spaces-space-id
parameters:
- description: The version of the API to use
@@ -39307,6 +37149,11 @@ paths:
responses:
'200':
description: Indicates a successful call.
+ content:
+ application/json; Elastic-Api-Version=2023-10-31:
+ examples:
+ getSpaceResponseExample:
+ $ref: '#/components/examples/get_space_response'
summary: Get a space
tags:
- spaces
@@ -39328,9 +37175,7 @@ paths:
schema:
example: 'true'
type: string
- - description: >-
- The space identifier. You are unable to change the ID with the
- update operation.
+ - description: The space identifier. You are unable to change the ID with the update operation.
in: path
name: id
required: true
@@ -39346,10 +37191,7 @@ paths:
_reserved:
type: boolean
color:
- description: >-
- The hexadecimal color code used in the space avatar. By
- default, the color is automatically generated from the space
- name.
+ description: The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
type: string
description:
description: A description for the space.
@@ -39361,26 +37203,13 @@ paths:
type: string
type: array
id:
- description: >-
- 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.
+ description: 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.
type: string
imageUrl:
- description: >-
- 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.
+ description: 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.
type: string
initials:
- description: >-
- One or two characters that are shown in the space avatar. By
- default, the initials are automatically generated from the
- space name.
+ description: One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.
maxLength: 2
type: string
name:
@@ -39397,6 +37226,9 @@ paths:
required:
- id
- name
+ examples:
+ updateSpaceRequest:
+ $ref: '#/components/examples/update_space_request'
responses:
'200':
description: Indicates a successful call.
@@ -39434,11 +37266,8 @@ paths:
schema:
anyOf:
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_response'
- - $ref: >-
- #/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse
- description: >-
- Kibana's operational status. A minimal response is sent for
- unauthorized users.
+ - $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse'
+ description: Kibana's operational status. A minimal response is sent for unauthorized users.
description: Overall status is OK and Kibana should be functioning normally.
'503':
content:
@@ -39446,14 +37275,9 @@ paths:
schema:
anyOf:
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_response'
- - $ref: >-
- #/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse
- description: >-
- Kibana's operational status. A minimal response is sent for
- unauthorized users.
- description: >-
- Kibana or some of it's essential services are unavailable. Kibana
- may be degraded or unavailable.
+ - $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse'
+ description: Kibana's operational status. A minimal response is sent for unauthorized users.
+ description: Kibana or some of it's essential services are unavailable. Kibana may be degraded or unavailable.
summary: Get Kibana's current status
tags:
- system
@@ -39472,9 +37296,7 @@ paths:
type: string
type: array
searchIds:
- description: >-
- Saved search ids that should be deleted alongside the
- timelines
+ description: Saved search ids that should be deleted alongside the timelines
items:
type: string
type: array
@@ -39502,7 +37324,6 @@ paths:
summary: Delete Timelines or Timeline templates
tags:
- Security Timeline API
- - access:securitySolution
get:
description: Get the details of an existing saved Timeline or Timeline template.
operationId: GetTimeline
@@ -39529,8 +37350,7 @@ paths:
type: object
properties:
getOneTimeline:
- $ref: >-
- #/components/schemas/Security_Timeline_API_TimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_TimelineResponse'
required:
- getOneTimeline
required:
@@ -39541,12 +37361,8 @@ paths:
summary: Get Timeline or Timeline template details
tags:
- Security Timeline API
- - access:securitySolution
patch:
- description: >-
- Update an existing Timeline. You can update the title, description, date
- range, pinned events, pinned queries, and/or pinned saved queries of an
- existing Timeline.
+ description: Update an existing Timeline. You can update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing Timeline.
operationId: PatchTimeline
requestBody:
content:
@@ -39573,12 +37389,8 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
- description: >-
- Indicates that the draft Timeline was successfully created. In the
- event the user already has a draft Timeline, the existing draft
- Timeline is cleared and returned.
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
+ description: Indicates that the draft Timeline was successfully created. In the event the user already has a draft Timeline, the existing draft Timeline is cleared and returned.
'405':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -39589,13 +37401,10 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates that the user does not have the required access to create
- a draft Timeline.
+ description: Indicates that the user does not have the required access to create a draft Timeline.
summary: Update a Timeline
tags:
- Security Timeline API
- - access:securitySolution
post:
description: Create a new Timeline or Timeline template.
operationId: CreateTimelines
@@ -39627,17 +37436,14 @@ paths:
type: string
required:
- timeline
- description: >-
- The required Timeline fields used to create a new Timeline, along with
- optional fields that will be created if not provided.
+ description: The required Timeline fields used to create a new Timeline, along with optional fields that will be created if not provided.
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
description: Indicates the Timeline was successfully created.
'405':
content:
@@ -39653,7 +37459,6 @@ paths:
summary: Create a Timeline or Timeline template
tags:
- Security Timeline API
- - access:securitySolution
/api/timeline/_copy:
get:
description: |
@@ -39678,19 +37483,14 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
description: Indicates that the timeline has been successfully copied.
summary: Copies timeline or timeline template
tags:
- Security Timeline API
- - access:securitySolution
/api/timeline/_draft:
get:
- description: >-
- Get the details of the draft Timeline or Timeline template for the
- current user. If the user doesn't have a draft Timeline, an empty
- Timeline is returned.
+ description: Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned.
operationId: GetDraftTimelines
parameters:
- in: query
@@ -39703,8 +37503,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
description: Indicates that the draft Timeline was successfully retrieved.
'403':
content:
@@ -39716,10 +37515,7 @@ paths:
type: string
status_code:
type: number
- description: >-
- If a draft Timeline was not found and we attempted to create one, it
- indicates that the user does not have the required permissions to
- create a draft Timeline.
+ description: If a draft Timeline was not found and we attempted to create one, it indicates that the user does not have the required permissions to create a draft Timeline.
'409':
content:
application:json; Elastic-Api-Version=2023-10-31:
@@ -39730,22 +37526,15 @@ paths:
type: string
status_code:
type: number
- description: >-
- This should never happen, but if a draft Timeline was not found and
- we attempted to create one, it indicates that there is already a
- draft Timeline with the given `timelineId`.
+ description: This should never happen, but if a draft Timeline was not found and we attempted to create one, it indicates that there is already a draft Timeline with the given `timelineId`.
summary: Get draft Timeline or Timeline template details
tags:
- Security Timeline API
- - access:securitySolution
post:
- description: >
+ description: |
Create a clean draft Timeline or Timeline template for the current user.
-
> info
-
- > If the user already has a draft Timeline, the existing draft Timeline
- is cleared and returned.
+ > If the user already has a draft Timeline, the existing draft Timeline is cleared and returned.
operationId: CleanDraftTimelines
requestBody:
content:
@@ -39757,21 +37546,15 @@ paths:
$ref: '#/components/schemas/Security_Timeline_API_TimelineType'
required:
- timelineType
- description: >-
- The type of Timeline to create. Valid values are `default` and
- `template`.
+ description: The type of Timeline to create. Valid values are `default` and `template`.
required: true
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_PersistTimelineResponse
- description: >-
- Indicates that the draft Timeline was successfully created. In the
- event the user already has a draft Timeline, the existing draft
- Timeline is cleared and returned.
+ $ref: '#/components/schemas/Security_Timeline_API_PersistTimelineResponse'
+ description: Indicates that the draft Timeline was successfully created. In the event the user already has a draft Timeline, the existing draft Timeline is cleared and returned.
'403':
content:
application:json; Elastic-Api-Version=2023-10-31:
@@ -39782,9 +37565,7 @@ paths:
type: string
status_code:
type: number
- description: >-
- Indicates that the user does not have the required permissions to
- create a draft Timeline.
+ description: Indicates that the user does not have the required permissions to create a draft Timeline.
'409':
content:
application:json; Elastic-Api-Version=2023-10-31:
@@ -39795,13 +37576,10 @@ paths:
type: string
status_code:
type: number
- description: >-
- Indicates that there is already a draft Timeline with the given
- `timelineId`.
+ description: Indicates that there is already a draft Timeline with the given `timelineId`.
summary: Create a clean draft Timeline or Timeline template
tags:
- Security Timeline API
- - access:securitySolution
/api/timeline/_export:
post:
description: Export Timelines as an NDJSON file.
@@ -39848,7 +37626,6 @@ paths:
summary: Export Timelines
tags:
- Security Timeline API
- - access:securitySolution
/api/timeline/_favorite:
patch:
description: Favorite a Timeline or Timeline template for the current user.
@@ -39889,8 +37666,7 @@ paths:
type: object
properties:
persistFavorite:
- $ref: >-
- #/components/schemas/Security_Timeline_API_FavoriteTimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_FavoriteTimelineResponse'
required:
- persistFavorite
required:
@@ -39906,13 +37682,10 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates the user does not have the required permissions to persist
- the favorite status.
+ description: Indicates the user does not have the required permissions to persist the favorite status.
summary: Favorite a Timeline or Timeline template
tags:
- Security Timeline API
- - access:securitySolution
/api/timeline/_import:
post:
description: Import Timelines.
@@ -39938,8 +37711,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_ImportTimelineResult
+ $ref: '#/components/schemas/Security_Timeline_API_ImportTimelineResult'
description: Indicates the import of Timelines was successful.
'400':
content:
@@ -39953,9 +37725,7 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates the import of Timelines was unsuccessful because of an
- invalid file extension.
+ description: Indicates the import of Timelines was unsuccessful because of an invalid file extension.
'404':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -39966,9 +37736,7 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates that we were unable to locate the saved object client
- necessary to handle the import.
+ description: Indicates that we were unable to locate the saved object client necessary to handle the import.
'409':
content:
application/json; Elastic-Api-Version=2023-10-31:
@@ -39985,7 +37753,6 @@ paths:
summary: Import Timelines
tags:
- Security Timeline API
- - access:securitySolution
/api/timeline/_prepackaged:
post:
description: Install or update prepackaged Timelines.
@@ -39998,8 +37765,7 @@ paths:
properties:
prepackagedTimelines:
items:
- $ref: >-
- #/components/schemas/Security_Timeline_API_TimelineSavedToReturnObject
+ $ref: '#/components/schemas/Security_Timeline_API_TimelineSavedToReturnObject'
nullable: true
type: array
timelinesToInstall:
@@ -40023,8 +37789,7 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
- $ref: >-
- #/components/schemas/Security_Timeline_API_ImportTimelineResult
+ $ref: '#/components/schemas/Security_Timeline_API_ImportTimelineResult'
description: Indicates the installation of prepackaged Timelines was successful.
'500':
content:
@@ -40036,13 +37801,10 @@ paths:
type: string
statusCode:
type: number
- description: >-
- Indicates the installation of prepackaged Timelines was
- unsuccessful.
+ description: Indicates the installation of prepackaged Timelines was unsuccessful.
summary: Install prepackaged Timelines
tags:
- Security Timeline API
- - access:securitySolution
/api/timeline/resolve:
get:
operationId: ResolveTimeline
@@ -40066,8 +37828,7 @@ paths:
- type: object
properties:
data:
- $ref: >-
- #/components/schemas/Security_Timeline_API_ResolvedTimeline
+ $ref: '#/components/schemas/Security_Timeline_API_ResolvedTimeline'
required:
- data
- additionalProperties: false
@@ -40080,15 +37841,12 @@ paths:
summary: Get an existing saved Timeline or Timeline template
tags:
- Security Timeline API
- - access:securitySolution
/api/timelines:
get:
description: Get a list of all saved Timelines or Timeline templates.
operationId: GetTimelines
parameters:
- - description: >-
- If true, only timelines that are marked as favorites by the user are
- returned.
+ - description: If true, only timelines that are marked as favorites by the user are returned.
in: query
name: only_user_favorite
schema:
@@ -40152,8 +37910,7 @@ paths:
type: number
timeline:
items:
- $ref: >-
- #/components/schemas/Security_Timeline_API_TimelineResponse
+ $ref: '#/components/schemas/Security_Timeline_API_TimelineResponse'
type: array
totalCount:
type: number
@@ -40175,12 +37932,10 @@ paths:
summary: Get Timelines or Timeline templates
tags:
- Security Timeline API
- - access:securitySolution
/s/{spaceId}/api/observability/slos:
get:
- description: >
- You must have the `read` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `read` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: findSlosOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40228,9 +37983,7 @@ paths:
- asc
- desc
type: string
- - description: >-
- Hide stale SLOs from the list as defined by stale SLO threshold in
- SLO settings
+ - description: Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings
in: query
name: hideStale
schema:
@@ -40270,9 +38023,8 @@ paths:
tags:
- slo
post:
- description: >
- You must have `all` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have `all` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: createSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40319,10 +38071,8 @@ paths:
- slo
/s/{spaceId}/api/observability/slos/_delete_instances:
post:
- description: >
- The deletion occurs for the specified list of `sloId` and `instanceId`.
- You must have `all` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ The deletion occurs for the specified list of `sloId` and `instanceId`. You must have `all` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: deleteSloInstancesOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40359,9 +38109,8 @@ paths:
- slo
/s/{spaceId}/api/observability/slos/{sloId}:
delete:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: deleteSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40398,9 +38147,8 @@ paths:
tags:
- slo
get:
- description: >
- You must have the `read` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `read` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: getSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40447,9 +38195,8 @@ paths:
tags:
- slo
put:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: updateSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40497,9 +38244,8 @@ paths:
- slo
/s/{spaceId}/api/observability/slos/{sloId}/_reset:
post:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: resetSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40541,9 +38287,8 @@ paths:
- slo
/s/{spaceId}/api/observability/slos/{sloId}/disable:
post:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: disableSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40581,9 +38326,8 @@ paths:
- slo
/s/{spaceId}/api/observability/slos/{sloId}/enable:
post:
- description: >
- You must have the `write` privileges for the **SLOs** feature in the
- **Observability** section of the Kibana feature privileges.
+ description: |
+ You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
operationId: enableSloOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
@@ -40864,9 +38608,7 @@ components:
owner: cases
type: user
Cases_add_comment_response:
- summary: >-
- The add comment to case API returns a JSON object that contains details
- about the case and its comments.
+ summary: The add comment to case API returns a JSON object that contains details about the case and its comments.
value:
assignees: []
category: null
@@ -40945,9 +38687,7 @@ components:
- tag-1
title: Case title 1
Cases_create_case_response:
- summary: >-
- The create case API returns a JSON object that contains details about
- the case.
+ summary: The create case API returns a JSON object that contains details about the case.
value:
assignees: []
closed_at: null
@@ -41066,9 +38806,7 @@ components:
type: assignees
version: WzM1ODg4LDFb
Cases_find_case_response:
- summary: >-
- Retrieve the first five cases with the `tag-1` tag, in ascending order
- by last update time.
+ summary: Retrieve the first five cases with the `tag-1` tag, in ascending order by last update time.
value:
cases:
- assignees: []
@@ -41193,9 +38931,7 @@ components:
updated_by: null
version: WzEyLDNd
Cases_get_case_observability_response:
- summary: >-
- Retrieves information about an Observability case including its alerts
- and comments.
+ summary: Retrieves information about an Observability case including its alerts and comments.
value:
assignees:
- uid: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
@@ -41372,9 +39108,7 @@ components:
- tag 1
- tag 2
Cases_push_case_response:
- summary: >-
- The push case API returns a JSON object with details about the case and
- the external service.
+ summary: The push case API returns a JSON object with details about the case and the external service.
value:
closed_at: null
closed_by: null
@@ -41423,9 +39157,7 @@ components:
username: elastic
version: WzE3NjgsM10=
Cases_set_case_configuration_request:
- summary: >-
- Set the closure type, custom fields, and default connector for Stack
- Management cases.
+ summary: Set the closure type, custom fields, and default connector for Stack Management cases.
value:
closure_type: close-by-user
connector:
@@ -41612,9 +39344,7 @@ components:
- tag-1
version: WzIzLDFd
Cases_update_case_response:
- summary: >-
- This is an example response when the case description, tags, and
- connector were updated.
+ summary: This is an example response when the case description, tags, and connector were updated.
value:
- assignees: []
category: null
@@ -41682,9 +39412,7 @@ components:
type: user
version: Wzk1LDFd
Cases_update_comment_response:
- summary: >-
- The add comment to case API returns a JSON object that contains details
- about the case and its comments.
+ summary: The add comment to case API returns a JSON object that contains details about the case and its comments.
value:
assignees: []
category: null
@@ -41769,9 +39497,7 @@ components:
source: emit(doc["foo"].value)
type: long
Data_views_get_data_view_response:
- summary: >-
- The get data view API returns a JSON object that contains information
- about the data view.
+ summary: The get data view API returns a JSON object that contains information about the data view.
value:
data_view:
allowNoIndex: false
@@ -42722,10 +40448,7 @@ components:
value:
data_view_id: ff959d40-b880-11e8-a6d9-e546fe2bba5f
Data_views_get_runtime_field_response:
- summary: >-
- The get runtime field API returns a JSON object that contains
- information about the runtime field (`hour_of_day`) and the data view
- (`d3d7af60-4c81-11e8-b3d7-01146121b73d`).
+ summary: The get runtime field API returns a JSON object that contains information about the runtime field (`hour_of_day`) and the data view (`d3d7af60-4c81-11e8-b3d7-01146121b73d`).
value:
data_view:
allowNoIndex: false
@@ -43234,9 +40957,7 @@ components:
data_view_id: ff959d40-b880-11e8-a6d9-e546fe2bba5f
force: true
Data_views_swap_data_view_request:
- summary: >-
- Swap references from data view ID "abcd-efg" to "xyz-123" and remove the
- data view that is no longer referenced.
+ summary: Swap references from data view ID "abcd-efg" to "xyz-123" and remove the data view that is no longer referenced.
value:
delete: true
fromId: abcd-efg
@@ -43287,25 +41008,12 @@ components:
- id: de71f4f0-1902-11e9-919b-ffe5949a18d2
type: map
Saved_objects_export_objects_response:
- summary: >-
- The export objects API response contains a JSON record for each exported
- object.
+ summary: The export objects API response contains a JSON record for each exported object.
value:
attributes:
description: ''
- layerListJSON: >-
- [{"id":"0hmz5","alpha":1,"sourceDescriptor":{"type":"EMS_TMS","isAutoSelect":true,"lightModeDefault":"road_map_desaturated"},"visible":true,"style":{},"type":"EMS_VECTOR_TILE","minZoom":0,"maxZoom":24},{"id":"edh66","label":"Total
- Requests by
- Destination","minZoom":0,"maxZoom":24,"alpha":0.5,"sourceDescriptor":{"type":"EMS_FILE","id":"world_countries","tooltipProperties":["name","iso2"]},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"DYNAMIC","options":{"field":{"name":"__kbnjoin__count__673ff994-fc75-4c67-909b-69fcb0e1060e","origin":"join"},"color":"Greys","fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"lineColor":{"type":"STATIC","options":{"color":"#FFFFFF"}},"lineWidth":{"type":"STATIC","options":{"size":1}},"iconSize":{"type":"STATIC","options":{"size":10}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR","joins":[{"leftField":"iso2","right":{"type":"ES_TERM_SOURCE","id":"673ff994-fc75-4c67-909b-69fcb0e1060e","indexPatternTitle":"kibana_sample_data_logs","term":"geo.dest","indexPatternRefName":"layer_1_join_0_index_pattern","metrics":[{"type":"count","label":"web
- logs
- count"}],"applyGlobalQuery":true}}]},{"id":"gaxya","label":"Actual
- Requests","minZoom":9,"maxZoom":24,"alpha":1,"sourceDescriptor":{"id":"b7486535-171b-4d3b-bb2e-33c1a0a2854c","type":"ES_SEARCH","geoField":"geo.coordinates","limit":2048,"filterByMapBounds":true,"tooltipProperties":["clientip","timestamp","host","request","response","machine.os","agent","bytes"],"indexPatternRefName":"layer_2_source_index_pattern","applyGlobalQuery":true,"scalingType":"LIMIT"},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"STATIC","options":{"color":"#2200ff"}},"lineColor":{"type":"STATIC","options":{"color":"#FFFFFF"}},"lineWidth":{"type":"STATIC","options":{"size":2}},"iconSize":{"type":"DYNAMIC","options":{"field":{"name":"bytes","origin":"source"},"minSize":1,"maxSize":23,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR"},{"id":"tfi3f","label":"Total
- Requests and
- Bytes","minZoom":0,"maxZoom":9,"alpha":1,"sourceDescriptor":{"type":"ES_GEO_GRID","resolution":"COARSE","id":"8aaa65b5-a4e9-448b-9560-c98cb1c5ac5b","geoField":"geo.coordinates","requestType":"point","metrics":[{"type":"count","label":"web
- logs
- count"},{"type":"sum","field":"bytes"}],"indexPatternRefName":"layer_3_source_index_pattern","applyGlobalQuery":true},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"color":"Blues","fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"lineColor":{"type":"STATIC","options":{"color":"#cccccc"}},"lineWidth":{"type":"STATIC","options":{"size":1}},"iconSize":{"type":"DYNAMIC","options":{"field":{"name":"sum_of_bytes","origin":"source"},"minSize":7,"maxSize":25,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"labelText":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"labelSize":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"minSize":12,"maxSize":24,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR"}]
- mapStateJSON: >-
- {"zoom":3.64,"center":{"lon":-88.92107,"lat":42.16337},"timeFilters":{"from":"now-7d","to":"now"},"refreshConfig":{"isPaused":true,"interval":0},"query":{"language":"kuery","query":""},"settings":{"autoFitToDataBounds":false}}
+ layerListJSON: '[{"id":"0hmz5","alpha":1,"sourceDescriptor":{"type":"EMS_TMS","isAutoSelect":true,"lightModeDefault":"road_map_desaturated"},"visible":true,"style":{},"type":"EMS_VECTOR_TILE","minZoom":0,"maxZoom":24},{"id":"edh66","label":"Total Requests by Destination","minZoom":0,"maxZoom":24,"alpha":0.5,"sourceDescriptor":{"type":"EMS_FILE","id":"world_countries","tooltipProperties":["name","iso2"]},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"DYNAMIC","options":{"field":{"name":"__kbnjoin__count__673ff994-fc75-4c67-909b-69fcb0e1060e","origin":"join"},"color":"Greys","fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"lineColor":{"type":"STATIC","options":{"color":"#FFFFFF"}},"lineWidth":{"type":"STATIC","options":{"size":1}},"iconSize":{"type":"STATIC","options":{"size":10}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR","joins":[{"leftField":"iso2","right":{"type":"ES_TERM_SOURCE","id":"673ff994-fc75-4c67-909b-69fcb0e1060e","indexPatternTitle":"kibana_sample_data_logs","term":"geo.dest","indexPatternRefName":"layer_1_join_0_index_pattern","metrics":[{"type":"count","label":"web logs count"}],"applyGlobalQuery":true}}]},{"id":"gaxya","label":"Actual Requests","minZoom":9,"maxZoom":24,"alpha":1,"sourceDescriptor":{"id":"b7486535-171b-4d3b-bb2e-33c1a0a2854c","type":"ES_SEARCH","geoField":"geo.coordinates","limit":2048,"filterByMapBounds":true,"tooltipProperties":["clientip","timestamp","host","request","response","machine.os","agent","bytes"],"indexPatternRefName":"layer_2_source_index_pattern","applyGlobalQuery":true,"scalingType":"LIMIT"},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"STATIC","options":{"color":"#2200ff"}},"lineColor":{"type":"STATIC","options":{"color":"#FFFFFF"}},"lineWidth":{"type":"STATIC","options":{"size":2}},"iconSize":{"type":"DYNAMIC","options":{"field":{"name":"bytes","origin":"source"},"minSize":1,"maxSize":23,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR"},{"id":"tfi3f","label":"Total Requests and Bytes","minZoom":0,"maxZoom":9,"alpha":1,"sourceDescriptor":{"type":"ES_GEO_GRID","resolution":"COARSE","id":"8aaa65b5-a4e9-448b-9560-c98cb1c5ac5b","geoField":"geo.coordinates","requestType":"point","metrics":[{"type":"count","label":"web logs count"},{"type":"sum","field":"bytes"}],"indexPatternRefName":"layer_3_source_index_pattern","applyGlobalQuery":true},"visible":true,"style":{"type":"VECTOR","properties":{"fillColor":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"color":"Blues","fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"lineColor":{"type":"STATIC","options":{"color":"#cccccc"}},"lineWidth":{"type":"STATIC","options":{"size":1}},"iconSize":{"type":"DYNAMIC","options":{"field":{"name":"sum_of_bytes","origin":"source"},"minSize":7,"maxSize":25,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"labelText":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"labelSize":{"type":"DYNAMIC","options":{"field":{"name":"doc_count","origin":"source"},"minSize":12,"maxSize":24,"fieldMetaOptions":{"isEnabled":false,"sigma":3}}},"symbolizeAs":{"options":{"value":"circle"}},"icon":{"type":"STATIC","options":{"value":"marker"}}}},"type":"GEOJSON_VECTOR"}]'
+ mapStateJSON: '{"zoom":3.64,"center":{"lon":-88.92107,"lat":42.16337},"timeFilters":{"from":"now-7d","to":"now"},"refreshConfig":{"isPaused":true,"interval":0},"query":{"language":"kuery","query":""},"settings":{"autoFitToDataBounds":false}}'
title: '[Logs] Total Requests and Bytes'
uiStateJSON: '{"isDarkMode":false}'
coreMigrationVersion: 8.8.0
@@ -43330,10 +41038,7 @@ components:
value:
file: file.ndjson
Saved_objects_import_objects_response:
- summary: >-
- The import objects API response indicates a successful import and the
- objects are created. Since these objects are created as new copies, each
- entry in the successResults array includes a destinationId attribute.
+ summary: The import objects API response indicates a successful import and the objects are created. Since these objects are created as new copies, each entry in the successResults array includes a destinationId attribute.
value:
success: true
successCount: 1
@@ -43389,6 +41094,1614 @@ components:
icon: dashboardApp
title: Look at my dashboard
type: dashboard
+ get_connector_types_generativeai_response:
+ summary: A list of connector types for the `generativeAI` feature.
+ value:
+ - id: .gen-ai
+ name: OpenAI
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAIForSecurity
+ - generativeAIForObservability
+ - generativeAIForSearchPlayground
+ is_system_action_type: false
+ - id: .bedrock
+ name: AWS Bedrock
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAIForSecurity
+ - generativeAIForObservability
+ - generativeAIForSearchPlayground
+ is_system_action_type: false
+ - id: .gemini
+ name: Google Gemini
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAIForSecurity
+ is_system_action_type: false
+ get_connector_response:
+ summary: Get connector details.
+ value:
+ id: df770e30-8b8b-11ed-a780-3b746c987a81
+ name: my_server_log_connector
+ config: {}
+ connector_type_id: .server-log
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ update_index_connector_request:
+ summary: Update an index connector.
+ value:
+ name: updated-connector
+ config:
+ index: updated-index
+ create_email_connector_request:
+ summary: Create an email connector.
+ value:
+ name: email-connector-1
+ connector_type_id: .email
+ config:
+ from: tester@example.com
+ hasAuth: true
+ host: https://example.com
+ port: 1025
+ secure: false
+ service: other
+ secrets:
+ user: username
+ password: password
+ create_index_connector_request:
+ summary: Create an index connector.
+ value:
+ name: my-connector
+ connector_type_id: .index
+ config:
+ index: test-index
+ create_webhook_connector_request:
+ summary: Create a webhook connector with SSL authentication.
+ value:
+ name: my-webhook-connector
+ connector_type_id: .webhook
+ config:
+ method: post
+ url: https://example.com
+ authType: webhook-authentication-ssl
+ certType: ssl-crt-key
+ secrets:
+ crt: QmFnIEF0dH...
+ key: LS0tLS1CRUdJ...
+ password: my-passphrase
+ create_xmatters_connector_request:
+ summary: Create an xMatters connector with URL authentication.
+ value:
+ name: my-xmatters-connector
+ connector_type_id: .xmatters
+ config:
+ usesBasic: false
+ secrets:
+ secretsUrl: https://example.com?apiKey=xxxxx
+ create_email_connector_response:
+ summary: A new email connector.
+ value:
+ id: 90a82c60-478f-11ee-a343-f98a117c727f
+ connector_type_id: .email
+ name: email-connector-1
+ config:
+ from: tester@example.com
+ service: other
+ host: https://example.com
+ port: 1025
+ secure: false
+ hasAuth: true
+ tenantId: null
+ clientId: null
+ oauthTokenUrl: null
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ create_index_connector_response:
+ summary: A new index connector.
+ value:
+ id: c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
+ connector_type_id: .index
+ name: my-connector
+ config:
+ index: test-index
+ refresh: false
+ executionTimeField: null
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ create_webhook_connector_response:
+ summary: A new webhook connector.
+ value:
+ id: 900eb010-3b9d-11ee-a642-8ffbb94e38bd
+ name: my-webhook-connector
+ config:
+ method: post
+ url: https://example.com
+ authType: webhook-authentication-ssl
+ certType: ssl-crt-key
+ verificationMode: full
+ headers: null
+ hasAuth: true
+ connector_type_id: .webhook
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ run_index_connector_request:
+ summary: Run an index connector.
+ value:
+ params:
+ documents:
+ - id: my_doc_id
+ name: my_doc_name
+ message: hello, world
+ run_jira_connector_request:
+ summary: Run a Jira connector to retrieve the list of issue types.
+ value:
+ params:
+ subAction: issueTypes
+ run_servicenow_itom_connector_request:
+ summary: Run a ServiceNow ITOM connector to retrieve the list of choices.
+ value:
+ params:
+ subAction: getChoices
+ subActionParams:
+ fields:
+ - severity
+ - urgency
+ run_slack_api_connector_request:
+ summary: Run a Slack connector that uses the web API method to post a message on a channel.
+ value:
+ params:
+ subAction: postMessage
+ subActionParams:
+ channelIds:
+ - C123ABC456
+ text: A test message.
+ run_swimlane_connector_request:
+ summary: Run a Swimlane connector to create an incident.
+ value:
+ params:
+ subAction: pushToService
+ subActionParams:
+ comments:
+ - commentId: 1
+ comment: A comment about the incident.
+ incident:
+ caseId: '1000'
+ caseName: Case name
+ description: Description of the incident.
+ run_index_connector_response:
+ summary: Response from running an index connector.
+ value:
+ connector_id: fd38c600-96a5-11ed-bb79-353b74189cba
+ data:
+ errors: false
+ items:
+ - create:
+ _id: 4JtvwYUBrcyxt2NnfW3y
+ _index: my-index
+ _primary_term: 1
+ _seq_no: 0
+ _shards:
+ failed: 0
+ successful: 1
+ total: 2
+ _version: 1
+ result: created
+ status: 201
+ took: 135
+ status: ok
+ run_jira_connector_response:
+ summary: Response from retrieving the list of issue types for a Jira connector.
+ value:
+ connector_id: b3aad810-edbe-11ec-82d1-11348ecbf4a6
+ data:
+ - id: 10024
+ name: Improvement
+ - id: 10006
+ name: Task
+ - id: 10007
+ name: Sub-task
+ - id: 10025
+ name: New Feature
+ - id: 10023
+ name: Bug
+ - id: 10000
+ name: Epic
+ status: ok
+ run_server_log_connector_response:
+ summary: Response from running a server log connector.
+ value:
+ connector_id: 7fc7b9a0-ecc9-11ec-8736-e7d63118c907
+ status: ok
+ run_servicenow_itom_connector_response:
+ summary: Response from retrieving the list of choices for a ServiceNow ITOM connector.
+ value:
+ connector_id: 9d9be270-2fd2-11ed-b0e0-87533c532698
+ data:
+ - dependent_value: ''
+ element: severity
+ label: Critical
+ value: 1
+ - dependent_value: ''
+ element: severity
+ label: Major
+ value: 2
+ - dependent_value: ''
+ element: severity
+ label: Minor
+ value: 3
+ - dependent_value: ''
+ element: severity
+ label: Warning
+ value: 4
+ - dependent_value: ''
+ element: severity
+ label: OK
+ value: 5
+ - dependent_value: ''
+ element: severity
+ label: Clear
+ value: 0
+ - dependent_value: ''
+ element: urgency
+ label: 1 - High
+ value: 1
+ - dependent_value: ''
+ element: urgency
+ label: 2 - Medium
+ value: 2
+ - dependent_value: ''
+ element: urgency
+ label: 3 - Low
+ value: 3
+ status: ok
+ run_slack_api_connector_response:
+ summary: Response from posting a message with a Slack connector.
+ value:
+ status: ok
+ data:
+ ok: true
+ channel: C123ABC456
+ ts: '1234567890.123456'
+ message:
+ bot_id: B12BCDEFGHI
+ type: message
+ text: A test message
+ user: U12A345BC6D
+ ts: '1234567890.123456'
+ app_id: A01BC2D34EF
+ blocks:
+ - type: rich_text
+ block_id: /NXe
+ elements:
+ - type: rich_text_section
+ elements:
+ - type: text
+ text: A test message.
+ team: T01ABCDE2F
+ bot_profile:
+ id: B12BCDEFGHI
+ app_id: A01BC2D34EF
+ name: test
+ icons:
+ image_36: https://a.slack-edge.com/80588/img/plugins/app/bot_36.png
+ deleted: false
+ updated: 1672169705
+ team_id: T01ABCDE2F
+ connector_id: .slack_api
+ run_swimlane_connector_response:
+ summary: Response from creating a Swimlane incident.
+ value:
+ connector_id: a4746470-2f94-11ed-b0e0-87533c532698
+ data:
+ id: aKPmBHWzmdRQtx6Mx
+ title: TEST-457
+ url: https://elastic.swimlane.url.us/record/aNcL2xniGHGpa2AHb/aKPmBHWzmdRQtx6Mx
+ pushedDate: '2022-09-08T16:52:27.866Z'
+ comments:
+ - commentId: 1
+ pushedDate: '2022-09-08T16:52:27.865Z'
+ status: ok
+ get_connectors_response:
+ summary: A list of connectors
+ value:
+ - id: preconfigured-email-connector
+ name: my-preconfigured-email-notification
+ connector_type_id: .email
+ is_preconfigured: true
+ is_deprecated: false
+ referenced_by_count: 0
+ is_system_action: false
+ - id: e07d0c80-8b8b-11ed-a780-3b746c987a81
+ name: my-index-connector
+ config:
+ index: test-index
+ refresh: false
+ executionTimeField: null
+ connector_type_id: .index
+ is_preconfigured: false
+ is_deprecated: false
+ referenced_by_count: 2
+ is_missing_secrets: false
+ is_system_action: false
+ update_rule_request:
+ summary: Index threshold rule
+ description: Update an index threshold rule that uses a server log connector to send notifications when the threshold is met.
+ value:
+ actions:
+ - frequency:
+ summary: false
+ notify_when: onActionGroupChange
+ group: threshold met
+ id: 96b668d0-a1b6-11ed-afdf-d39a49596974
+ params:
+ level: info
+ message: |-
+ Rule {{rule.name}} is active for group {{context.group}}:
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}}
+ params:
+ aggField: sheet.version
+ aggType: avg
+ index:
+ - .updated-index
+ groupBy: top
+ termField: name.keyword
+ termSize: 6
+ threshold:
+ - 1000
+ thresholdComparator: '>'
+ timeField: '@timestamp'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ name: new name
+ schedule:
+ interval: 1m
+ tags: []
+ update_rule_response:
+ summary: Index threshold rule
+ description: The response for successfully updating an index threshold rule.
+ value:
+ id: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
+ consumer: alerts
+ tags: []
+ name: new name
+ enabled: true
+ throttle: null
+ revision: 1
+ running: false
+ schedule:
+ interval: 1m
+ params:
+ index:
+ - .updated-index
+ timeField: '@timestamp'
+ groupBy: top
+ aggType: avg
+ timeWindowSize: 5
+ timeWindowUnit: m
+ thresholdComparator: '>'
+ threshold:
+ - 1000
+ aggField: sheet.version
+ termField: name.keyword
+ termSize: 6
+ api_key_owner: elastic
+ created_by: elastic
+ updated_by: elastic
+ rule_type_id: .index-threshold
+ scheduled_task_id: 4c5eda00-e74f-11ec-b72f-5b18752ff9ea
+ created_at: '2024-03-26T23:13:20.985Z'
+ updated_at: '2024-03-26T23:22:59.949Z'
+ mute_all: false
+ muted_alert_ids: []
+ execution_status:
+ status: ok
+ last_execution_date: '2024-03-26T23:22:51.390Z'
+ last_duration: 52
+ actions:
+ - group: threshold met
+ params:
+ level: info
+ message: |-
+ Rule {{rule.name}} is active for group {{context.group}}:
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}
+ id: 96b668d0-a1b6-11ed-afdf-d39a49596974
+ uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
+ connector_type_id: .server-log
+ frequency:
+ summary: false
+ throttle: null
+ notify_when: onActionGroupChange
+ last_run:
+ alerts_count:
+ new: 0
+ ignored: 0
+ recovered: 0
+ active: 0
+ outcome_msg: null
+ warning: null
+ outcome: succeeded
+ next_run: '2024-03-26T23:23:51.316Z'
+ api_key_created_by_user: false
+ create_es_query_esql_rule_request:
+ summary: Elasticsearch query rule (ES|QL)
+ description: |
+ Create an Elasticsearch query rule that uses Elasticsearch Query Language (ES|QL) to define its query and a server log connector to send notifications.
+ value:
+ name: my Elasticsearch query ESQL rule
+ params:
+ searchType: esqlQuery
+ esqlQuery:
+ esql: FROM kibana_sample_data_logs | KEEP bytes, clientip, host, geo.dest | where geo.dest != "GB" | STATS sumbytes = sum(bytes) by clientip, host | WHERE sumbytes > 5000 | SORT sumbytes desc | LIMIT 10
+ timeField: '@timestamp'
+ timeWindowSize: 1
+ timeWindowUnit: d
+ size: 0
+ thresholdComparator: '>'
+ threshold:
+ - 0
+ consumer: stackAlerts
+ rule_type_id: .es-query
+ schedule:
+ interval: 1d
+ actions:
+ - group: query matched
+ id: d0db1fe0-78d6-11ee-9177-f7d404c8c945
+ params:
+ level: info
+ message: |-
+ Elasticsearch query rule '{{rule.name}}' is active:
+ - Value: {{context.value}} - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}} - Timestamp: {{context.date}} - Link: {{context.link}}
+ frequency:
+ summary: false
+ notify_when: onActiveAlert
+ create_es_query_rule_request:
+ summary: Elasticsearch query rule (DSL)
+ description: |
+ Create an Elasticsearch query rule that uses Elasticsearch query domain specific language (DSL) to define its query and a server log connector to send notifications.
+ value:
+ actions:
+ - group: query matched
+ params:
+ level: info
+ message: The system has detected {{alerts.new.count}} new, {{alerts.ongoing.count}} ongoing, and {{alerts.recovered.count}} recovered alerts.
+ id: fdbece50-406c-11ee-850e-c71febc4ca7f
+ frequency:
+ throttle: 1d
+ summary: true
+ notify_when: onThrottleInterval
+ - group: recovered
+ params:
+ level: info
+ message: Recovered
+ id: fdbece50-406c-11ee-850e-c71febc4ca7f
+ frequency:
+ summary: false
+ notify_when: onActionGroupChange
+ consumer: alerts
+ name: my Elasticsearch query rule
+ params:
+ esQuery: '"""{"query":{"match_all" : {}}}"""'
+ index:
+ - kibana_sample_data_logs
+ size: 100
+ threshold:
+ - 100
+ thresholdComparator: '>'
+ timeField: '@timestamp'
+ timeWindowSize: 1
+ timeWindowUnit: d
+ rule_type_id: .es-query
+ schedule:
+ interval: 1d
+ create_es_query_kql_rule_request:
+ summary: Elasticsearch query rule (KQL)
+ description: Create an Elasticsearch query rule that uses Kibana query language (KQL).
+ value:
+ consumer: alerts
+ name: my Elasticsearch query KQL rule
+ params:
+ aggType: count
+ excludeHitsFromPreviousRun: true
+ groupBy: all
+ searchConfiguration:
+ query:
+ query: '""geo.src : "US" ""'
+ language: kuery
+ index: 90943e30-9a47-11e8-b64d-95841ca0b247
+ searchType: searchSource
+ size: 100
+ threshold:
+ - 1000
+ thresholdComparator: '>'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ rule_type_id: .es-query
+ schedule:
+ interval: 1m
+ create_index_threshold_rule_request:
+ summary: Index threshold rule
+ description: |
+ Create an index threshold rule that uses a server log connector to send notifications when the threshold is met.
+ value:
+ actions:
+ - id: 48de3460-f401-11ed-9f8e-399c75a2deeb
+ frequency:
+ notify_when: onActionGroupChange
+ summary: false
+ group: threshold met
+ params:
+ level: info
+ message: |-
+ Rule '{{rule.name}}' is active for group '{{context.group}}':
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}}
+ alert_delay:
+ active: 3
+ consumer: alerts
+ name: my rule
+ params:
+ aggType: avg
+ termSize: 6
+ thresholdComparator: '>'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ groupBy: top
+ threshold:
+ - 1000
+ index:
+ - .test-index
+ timeField: '@timestamp'
+ aggField: sheet.version
+ termField: name.keyword
+ rule_type_id: .index-threshold
+ schedule:
+ interval: 1m
+ tags:
+ - cpu
+ create_tracking_containment_rule_request:
+ summary: Tracking containment rule
+ description: |
+ Create a tracking containment rule that checks when an entity is contained or no longer contained within a boundary.
+ value:
+ consumer: alerts
+ name: my tracking rule
+ params:
+ index: kibana_sample_data_logs
+ dateField": '@timestamp'
+ geoField: geo.coordinates
+ entity: agent.keyword
+ boundaryType: entireIndex
+ boundaryIndexTitle: boundary*
+ boundaryGeoField: location
+ boundaryNameField: name
+ indexId: 90943e30-9a47-11e8-b64d-95841ca0b247
+ boundaryIndexId: 0cd90abf-abe7-44c7-909a-f621bbbcfefc
+ rule_type_id: .geo-containment
+ schedule:
+ interval: 1h
+ create_es_query_esql_rule_response:
+ summary: Elasticsearch query rule (ES|QL)
+ description: The response for successfully creating an Elasticsearch query rule that uses Elasticsearch Query Language (ES|QL).
+ value:
+ id: e0d62360-78e8-11ee-9177-f7d404c8c945
+ enabled: true
+ name: my Elasticsearch query ESQL rule
+ tags: []
+ rule_type_id: .es-query
+ consumer: stackAlerts
+ schedule:
+ interval: 1d
+ actions:
+ - group: query matched
+ id: d0db1fe0-78d6-11ee-9177-f7d404c8c945
+ params:
+ level: info
+ message: |-
+ Elasticsearch query rule '{{rule.name}}' is active:
+ - Value: {{context.value}} - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}} - Timestamp: {{context.date}} - Link: {{context.link}}
+ connector_type_id: .server-log
+ frequency:
+ summary: false
+ notify_when: onActiveAlert
+ throttle: null
+ uuid: bfe370a3-531b-4855-bbe6-ad739f578844
+ params:
+ searchType: esqlQuery
+ esqlQuery:
+ esql: FROM kibana_sample_data_logs | keep bytes, clientip, host, geo.dest | WHERE geo.dest != "GB" | stats sumbytes = sum(bytes) by clientip, host | WHERE sumbytes > 5000 | sort sumbytes desc | limit 10
+ timeField: '@timestamp'
+ timeWindowSize: 1
+ timeWindowUnit: d
+ size: 0
+ thresholdComparator: '>'
+ threshold:
+ - 0
+ excludeHitsFromPreviousRun": true,
+ aggType: count
+ groupBy: all
+ scheduled_task_id: e0d62360-78e8-11ee-9177-f7d404c8c945
+ created_by: elastic
+ updated_by: elastic",
+ created_at: '2023-11-01T19:00:10.453Z'
+ updated_at: '2023-11-01T19:00:10.453Z'
+ api_key_owner: elastic
+ api_key_created_by_user: false
+ throttle: null
+ mute_all: false
+ notify_when: null
+ muted_alert_ids: []
+ execution_status:
+ status: pending
+ last_execution_date: '2023-11-01T19:00:10.453Z'
+ revision: 0
+ running: false
+ create_es_query_rule_response:
+ summary: Elasticsearch query rule (DSL)
+ description: The response for successfully creating an Elasticsearch query rule that uses Elasticsearch query domain specific language (DSL).
+ value:
+ id: 58148c70-407f-11ee-850e-c71febc4ca7f
+ enabled: true
+ name: my Elasticsearch query rule
+ tags: []
+ rule_type_id: .es-query
+ consumer: alerts
+ schedule:
+ interval: 1d
+ actions:
+ - group: query matched
+ id: fdbece50-406c-11ee-850e-c71febc4ca7f
+ params:
+ level: info
+ message: The system has detected {{alerts.new.count}} new, {{alerts.ongoing.count}} ongoing, and {{alerts.recovered.count}} recovered alerts.
+ connector_type_id: .server-log
+ frequency:
+ summary: true
+ notify_when: onThrottleInterval
+ throttle: 1d
+ uuid: 53f3c2a3-e5d0-4cfa-af3b-6f0881385e78
+ - group: recovered
+ id: fdbece50-406c-11ee-850e-c71febc4ca7f
+ params:
+ level: info
+ message: Recovered
+ connector_type_id: .server-log
+ frequency:
+ summary: false
+ notify_when: onActionGroupChange
+ throttle: null
+ uuid: 2324e45b-c0df-45c7-9d70-4993e30be758
+ params:
+ thresholdComparator: '>'
+ timeWindowSize: 1
+ timeWindowUnit: d
+ threshold:
+ - 100
+ size: 100
+ timeField: '@timestamp'
+ index:
+ - kibana_sample_data_logs
+ esQuery: '"""{"query":{"match_all" : {}}}"""'
+ excludeHitsFromPreviousRun: true
+ aggType: count
+ groupBy: all
+ searchType: esQuery
+ scheduled_task_id: 58148c70-407f-11ee-850e-c71febc4ca7f
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2023-08-22T00:03:38.263Z'
+ updated_at: '2023-08-22T00:03:38.263Z'
+ api_key_owner: elastic
+ api_key_created_by_user: false
+ throttle: null
+ mute_all: false
+ notify_when: null
+ muted_alert_ids: []
+ execution_status:
+ status: pending
+ last_execution_date: '2023-08-22T00:03:38.263Z'
+ revision: 0
+ running: false
+ create_es_query_kql_rule_response:
+ summary: Elasticsearch query rule (KQL)
+ description: The response for successfully creating an Elasticsearch query rule that uses Kibana query language (KQL).
+ value:
+ id: 7bd506d0-2284-11ee-8fad-6101956ced88
+ enabled: true
+ name: my Elasticsearch query KQL rule"
+ tags: []
+ rule_type_id: .es-query
+ consumer: alerts
+ schedule:
+ interval: 1m
+ actions: []
+ params:
+ searchConfiguration:
+ query:
+ query: '""geo.src : "US" ""'
+ language: kuery
+ index: 90943e30-9a47-11e8-b64d-95841ca0b247
+ searchType: searchSource
+ timeWindowSize: 5
+ timeWindowUnit: m
+ threshold:
+ - 1000
+ thresholdComparator: '>'
+ size: 100
+ aggType: count
+ groupBy: all
+ excludeHitsFromPreviousRun: true
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2023-07-14T20:24:50.729Z'
+ updated_at: '2023-07-14T20:24:50.729Z'
+ api_key_owner: elastic
+ api_key_created_by_user: false
+ throttle: null
+ notify_when: null
+ mute_all: false
+ muted_alert_ids: []
+ scheduled_task_id: 7bd506d0-2284-11ee-8fad-6101956ced88
+ execution_status:
+ status: pending
+ last_execution_date: '2023-07-14T20:24:50.729Z'
+ revision: 0
+ running: false
+ create_index_threshold_rule_response:
+ summary: Index threshold rule
+ description: The response for successfully creating an index threshold rule.
+ value:
+ actions:
+ - group: threshold met
+ id: dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2
+ uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
+ connector_type_id: .server-log
+ frequency:
+ notify_when: onActionGroupChange
+ summary: false
+ throttle: null
+ params:
+ level: info
+ message: |-
+ Rule {{rule.name}} is active for group {{context.group} :
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}}
+ alert_delay:
+ active: 3
+ api_key_created_by_user: false
+ api_key_owner: elastic
+ consumer: alerts
+ created_at: '2022-06-08T17:20:31.632Z'
+ created_by: elastic
+ enabled: true
+ execution_status:
+ last_execution_date: '2022-06-08T17:20:31.632Z'
+ status: pending
+ id: 41893910-6bca-11eb-9e0d-85d233e3ee35
+ muted_alert_ids: []
+ mute_all: false
+ name: my rule
+ notify_when: null
+ params:
+ aggType: avg
+ termSize: 6
+ thresholdComparator: '>'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ groupBy: top
+ threshold:
+ - 1000
+ index:
+ - .test-index
+ timeField: '@timestamp'
+ aggField: sheet.version
+ termField: name.keyword
+ revision: 0
+ rule_type_id: .index-threshold
+ running: false
+ schedule:
+ interval: 1m
+ scheduled_task_id: 425b0800-6bca-11eb-9e0d-85d233e3ee35
+ tags:
+ - cpu
+ throttle: null
+ updated_at: '2022-06-08T17:20:31.632Z'
+ updated_by: elastic
+ create_tracking_containment_rule_response:
+ summary: Tracking containment rule
+ description: The response for successfully creating a tracking containment rule.
+ value:
+ id: b6883f9d-5f70-4758-a66e-369d7c26012f
+ name: my tracking rule
+ tags: []
+ enabled: true
+ consumer: alerts
+ throttle: null
+ revision: 1
+ running: false
+ schedule:
+ interval: 1h
+ params:
+ index: kibana_sample_data_logs
+ dateField: '@timestamp'
+ geoField: geo.coordinates
+ entity: agent.keyword
+ boundaryType: entireIndex
+ boundaryIndexTitle: boundary*
+ boundaryGeoField: location
+ boundaryNameField: name
+ indexId: 90943e30-9a47-11e8-b64d-95841ca0b247
+ boundaryIndexId: 0cd90abf-abe7-44c7-909a-f621bbbcfefc
+ rule_type_id: .geo-containment
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2024-02-14T19:52:55.920Z'
+ updated_at: '2024-02-15T03:24:32.574Z'
+ api_key_owner: elastic
+ notify_when: null
+ mute_all: false
+ muted_alert_ids: []
+ scheduled_task_id: b6883f9d-5f70-4758-a66e-369d7c26012f
+ execution_status:
+ status: ok
+ last_execution_date: '2024-02-15T03:25:38.125Z'
+ last_duration: 74
+ actions: []
+ last_run:
+ alerts_count:
+ active: 0
+ new: 0
+ recovered: 0
+ ignored: 0
+ outcome_msg: null
+ outcome_order: 0
+ outcome: succeeded
+ warning: null
+ next_run: '2024-02-15T03:26:38.033Z'
+ api_key_created_by_user: false
+ find_rules_response:
+ summary: Index threshold rule
+ description: A response that contains information about an index threshold rule.
+ value:
+ page: 1
+ total: 1
+ per_page: 10
+ data:
+ - id: 3583a470-74f6-11ed-9801-35303b735aef
+ consumer: alerts
+ tags:
+ - cpu
+ name: my alert
+ enabled: true
+ throttle: null
+ schedule:
+ interval: 1m
+ params:
+ aggType: avg
+ termSize: 6
+ thresholdComparator: '>'
+ timeWindowSize: 5
+ timeWindowUnit: m
+ groupBy: top
+ threshold:
+ - 1000
+ index:
+ - test-index
+ timeField: '@timestamp'
+ aggField: sheet.version
+ termField: name.keyword
+ revision: 1
+ rule_type_id: .index-threshold
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2022-12-05T23:40:33.132Z'
+ updated_at: '2022-12-05T23:40:33.132Z'
+ api_key_owner: elastic
+ mute_all: false
+ muted_alert_ids: []
+ scheduled_task_id: 3583a470-74f6-11ed-9801-35303b735aef
+ execution_status:
+ status: ok
+ last_execution_date: '2022-12-06T01:44:23.983Z'
+ last_duration: 48
+ actions:
+ - id: 9dca3e00-74f5-11ed-9801-35303b735aef
+ group: threshold met
+ uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
+ params:
+ level: info
+ message: |-
+ Rule {{rule.name}} is active for group {{context.group}}:
+
+ - Value: {{context.value}}
+ - Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}
+ - Timestamp: {{context.date}}
+ connector_type_id: .server-log
+ frequency:
+ summary: false
+ notify_when: onActionGroupChange
+ throttle: null
+ last_run:
+ alerts_count:
+ new: 0
+ ignored: 0
+ recovered: 0
+ active: 0
+ outcome_msg: null
+ warning: null
+ outcome: succeeded
+ next_run: '2022-12-06T01:45:23.912Z'
+ api_key_created_by_user: false
+ find_rules_response_conditional_action:
+ summary: Security rule
+ description: A response that contains information about a security rule that has conditional actions.
+ value:
+ page: 1
+ total: 1
+ per_page: 10
+ data:
+ - id: 6107a8f0-f401-11ed-9f8e-399c75a2deeb
+ name: security_rule
+ consumer: siem
+ enabled: true
+ tags: []
+ throttle: null
+ revision: 1
+ running: false
+ schedule:
+ interval: 1m
+ params:
+ author: []
+ description: A security threshold rule.
+ ruleId: an_internal_rule_id
+ falsePositives: []
+ from: now-3660s
+ immutable: false
+ license: ''
+ outputIndex: ''
+ meta:
+ from: 1h
+ kibana_siem_app_url: https://localhost:5601/app/security
+ maxSignals: 100
+ riskScore: 21
+ riskScoreMapping: []
+ severity: low
+ severityMapping: []
+ threat: []
+ to: now
+ references: []
+ version: 1
+ exceptionsList: []
+ type: threshold
+ language: kuery
+ index:
+ - kibana_sample_data_logs
+ query: '*'
+ filters: []
+ threshold:
+ field:
+ - bytes
+ value: 1
+ cardinality: []
+ rule_type_id: siem.thresholdRule
+ created_by: elastic
+ updated_by: elastic
+ created_at: '2023-05-16T15:50:28.358Z'
+ updated_at: '2023-05-16T20:25:42.559Z'
+ api_key_owner: elastic
+ notify_when: null
+ mute_all: false
+ muted_alert_ids: []
+ scheduled_task_id: 6107a8f0-f401-11ed-9f8e-399c75a2deeb
+ execution_status:
+ status: ok
+ last_execution_date: '2023-05-16T20:26:49.590Z'
+ last_duration: 166
+ actions:
+ - group: default
+ id: 49eae970-f401-11ed-9f8e-399c75a2deeb
+ params:
+ documents:
+ - rule_id:
+ '[object Object]': null
+ rule_name:
+ '[object Object]': null
+ alert_id:
+ '[object Object]': null
+ context_message:
+ '[object Object]': null
+ connector_type_id: .index
+ frequency:
+ summary: true
+ notify_when: onActiveAlert
+ throttle: null
+ uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
+ alerts_filter:
+ timeframe:
+ days:
+ - 7
+ timezone: UTC
+ hours:
+ start: '08:00'
+ end: '17:00'
+ query:
+ kql: ''
+ filters:
+ - meta:
+ disabled: false
+ negate: false
+ alias: null
+ index: c4bdca79-e69e-4d80-82a1-e5192c621bea
+ key: client.geo.region_iso_code
+ field: client.geo.region_iso_code
+ params:
+ query: CA-QC
+ type: phrase
+ $state:
+ store: appState
+ query:
+ match_phrase:
+ client.geo.region_iso_code: CA-QC
+ last_run:
+ alerts_count:
+ new: 0
+ ignored: 0
+ recovered: 0
+ active: 0
+ outcome_msg:
+ - Rule execution completed successfully
+ outcome_order: 0
+ warning: null
+ outcome: succeeded
+ next_run: '2023-05-16T20:27:49.507Z'
+ api_key_created_by_user: false
+ get_roles_response1:
+ summary: Get all role details
+ value:
+ - name: my_kibana_role
+ description: My kibana role description
+ metadata:
+ version: 1
+ transient_metadata:
+ enabled: true
+ elasticsearch:
+ indices: []
+ cluster: []
+ run_as: []
+ kibana:
+ - base:
+ - all
+ feature: {}
+ spaces:
+ - '*'
+ - name: my_admin_role
+ description: My admin role description
+ metadata:
+ version: 1
+ transient_metadata:
+ enabled: true
+ elasticsearch:
+ cluster:
+ - all
+ indices:
+ - names:
+ - index1
+ - index2
+ privileges:
+ - all
+ field_security:
+ grant:
+ - title
+ - body
+ query: '{\"match\": {\"title\": \"foo\"}}'
+ kibana: []
+ get_role_response1:
+ summary: Get role details
+ value:
+ name: my_kibana_role
+ description: Grants all cluster privileges and full access to index1 and index2. Grants full access to remote_index1 and remote_index2, and the monitor_enrich cluster privilege on remote_cluster1. Grants all Kibana privileges in the default space.
+ metadata:
+ version: 1
+ transient_metadata:
+ enabled: true
+ elasticsearch:
+ cluster:
+ - all
+ remote_cluster:
+ - privileges:
+ - monitor_enrich
+ clusters:
+ - remote_cluster1
+ indices:
+ - names:
+ - index1
+ - index2
+ privileges:
+ - all
+ allow_restricted_indices: false
+ remote_indices:
+ - names:
+ - remote_index1
+ - remote_index2
+ privileges:
+ - all
+ allow_restricted_indices: false
+ clusters:
+ - remote_cluster1
+ run_as: []
+ kibana:
+ - base:
+ - all
+ feature: {}
+ spaces:
+ - default
+ _transform_error: []
+ _unrecognized_applications: []
+ create_role_request1:
+ summary: Feature privileges in multiple spaces
+ description: Grant access to various features in some spaces.
+ value:
+ description: Grant full access to discover and dashboard features in the default space. Grant read access in the marketing, and sales spaces.
+ metadata:
+ version: 1
+ elasticsearch:
+ cluster: []
+ indices: []
+ kibana:
+ - base: []
+ feature:
+ discover:
+ - all
+ dashboard:
+ - all
+ spaces:
+ - default
+ - base:
+ - read
+ spaces:
+ - marketing
+ - sales
+ create_role_request2:
+ summary: Dashboard privileges in a space
+ description: Grant access to dashboard features in a Marketing space.
+ value:
+ description: Grant dashboard access in the Marketing space.
+ metadata:
+ version: 1
+ elasticsearch:
+ cluster: []
+ indices: []
+ kibana:
+ - base: []
+ feature:
+ dashboard:
+ - read
+ spaces:
+ - marketing
+ create_role_request3:
+ summary: Feature privileges in a space
+ description: Grant full access to all features in the default space.
+ value:
+ metadata:
+ version: 1
+ elasticsearch:
+ cluster: []
+ indices: []
+ kibana:
+ - base:
+ - all
+ feature: {}
+ spaces:
+ - default
+ create_role_request4:
+ summary: Elasticsearch and Kibana feature privileges
+ description: Grant Elasticsearch and Kibana feature privileges.
+ value:
+ description: Grant all cluster privileges and full access to index1 and index2. Grant full access to remote_index1 and remote_index2, and the monitor_enrich cluster privilege on remote_cluster1. Grant all Kibana privileges in the default space.
+ metadata:
+ version: 1
+ elasticsearch:
+ cluster:
+ - all
+ indices:
+ - names:
+ - index1
+ - index2
+ privileges:
+ - all
+ remote_indices:
+ - clusters:
+ - remote_cluster1
+ names:
+ - remote_index1
+ - remote_index2
+ privileges:
+ - all
+ remote_cluster:
+ - clusters:
+ - remote_cluster1
+ privileges:
+ - monitor_enrich
+ kibana:
+ - base:
+ - all
+ feature: {}
+ spaces:
+ - default
+ copy_saved_objects_request1:
+ summary: Copy with createNewCopies
+ description: |
+ Copy a dashboard with the my-dashboard ID, including all references from the default space to the marketing space. In this example, the dashboard has a reference to a visualization and that has a reference to a data view.
+ value:
+ objects:
+ - type: dashboard
+ id: my-dashboard
+ spaces:
+ - marketing
+ includeReferences: true
+ copy_saved_objects_request2:
+ summary: Copy without createNewCopies
+ description: |
+ Copy a dashboard with the my-dashboard ID, including all references from the default space to the marketing space. In this example, the dashboard has a reference to a visualization and that has a reference to a data view.
+ value:
+ objects:
+ - type: dashboard
+ id: my-dashboard
+ spaces:
+ - marketing
+ includeReferences: true
+ createNewCopies: false
+ copy_saved_objects_response1:
+ summary: Copy with createNewCopies
+ description: |
+ The response for successfully copying a dashboard with the my-dashboard ID, including all references from the default space to the marketing space. The result indicates a successful copy and all three objects are created. Since these objects were created as new copies, each entry in the successResults array includes a destinationId attribute.
+ value:
+ marketing:
+ success: true
+ successCount: 3
+ successResults:
+ - id: my-dashboard
+ type: dashboard
+ destinationId: 1e127098-5b80-417f-b0f1-c60c8395358f
+ meta:
+ icon: dashboardApp
+ title: Look at my dashboard
+ - id: my-vis
+ type: visualization
+ destinationId: a610ed80-1c73-4507-9e13-d3af736c8e04
+ meta:
+ icon: visualizeApp
+ title: Look at my visualization
+ - id: my-index-pattern
+ type: index-pattern
+ destinationId: bc3c9c70-bf6f-4bec-b4ce-f4189aa9e26b
+ meta:
+ icon: indexPatternApp
+ title: my-pattern-*
+ copy_saved_objects_response2:
+ summary: Copy without createNewCopies
+ description: |
+ The response for successfully copying a dashboard with the my-dashboard ID with createNewCopies turned off. The result indicates a successful copy and all three objects are created.
+ value:
+ marketing:
+ success: true
+ successCount: 3
+ successResults:
+ - id: my-dashboard
+ type: dashboard
+ meta:
+ icon: dashboardApp
+ title: Look at my dashboard
+ - id: my-vis
+ type: visualization
+ meta:
+ icon: visualizeApp
+ title: Look at my visualization
+ - id: my-index-pattern
+ type: index-pattern
+ meta:
+ icon: indexPatternApp
+ title: my-pattern-*
+ copy_saved_objects_response3:
+ summary: Failed copy response with conflict errors
+ description: |
+ A response for a failed copy of a dashboard with the my-dashboard ID including all references from the default space to the marketing and sales spaces. In this example, the dashboard has a reference to a visualization and a Canvas workpad and the visualization has a reference to an index pattern. The result indicates a successful copy for the marketing space and an unsuccessful copy for the sales space because the data view, visualization, and Canvas workpad each resulted in a conflict error. Objects are created when the error is resolved using the resolve copy conflicts API.
+ value:
+ marketing:
+ success: true
+ successCount: 4
+ successResults:
+ - id: my-dashboard
+ type: dashboard
+ meta:
+ icon: dashboardApp
+ title: Look at my dashboard
+ - id: my-vis
+ type: visualization
+ meta:
+ icon: visualizeApp
+ title: Look at my visualization
+ - id: my-canvas
+ type: canvas-workpad
+ meta:
+ icon: canvasApp
+ title: Look at my canvas
+ - id: my-index-pattern
+ type: index-pattern
+ meta:
+ icon: indexPatternApp
+ title: my-pattern-*
+ sales:
+ success: false
+ successCount: 1,
+ errors:
+ - id: my-pattern
+ type: index-pattern
+ title: my-pattern-*
+ error:
+ type: conflict
+ meta:
+ icon: indexPatternApp
+ title: my-pattern-*
+ - id: my-visualization
+ type: my-vis
+ title: Look at my visualization
+ error:
+ type: conflict
+ destinationId: another-vis
+ meta:
+ icon: visualizeApp
+ title: Look at my visualization
+ - id: my-canvas
+ type: canvas-workpad
+ title: Look at my canvas
+ error:
+ type: ambiguous_conflict
+ destinations:
+ - id: another-canvas
+ title: Look at another canvas
+ updatedAt: '2020-07-08T16:36:32.377Z'
+ - id: yet-another-canvas
+ title: Look at yet another canvas
+ updatedAt: '2020-07-05T12:29:54.849Z'
+ meta:
+ icon: canvasApp
+ title: Look at my canvas
+ successResults":
+ - id: my-dashboard
+ type: dashboard
+ meta:
+ icon: dashboardApp
+ title: Look at my dashboard
+ copy_saved_objects_response4:
+ summary: Failed copy with missing reference errors
+ description: |
+ The response for successfully copying a dashboard with the my-dashboard ID, including all references from the default space to the marketing space. In this example, the dashboard has a reference to a visualization and a Canvas workpad and the visualization has a reference to a data view. The result indicates an unsuccessful copy because the visualization resulted in a missing references error. Objects are created when the errors are resolved using the resolve copy conflicts API.
+ value:
+ marketing:
+ success: false
+ successCount: 2
+ errors:
+ - id: my-vis
+ type: visualization
+ title: Look at my visualization
+ error:
+ type: missing_references
+ references:
+ - type: index-pattern
+ id: my-pattern-*
+ meta:
+ icon: visualizeApp
+ title: Look at my visualization
+ successResults:
+ - id: my-dashboard
+ type: dashboard
+ meta:
+ icon: dashboardApp
+ title: Look at my dashboard
+ - id: my-canvas
+ type: canvas-workpad
+ meta:
+ icon: canvasApp
+ title: Look at my canvas
+ disable_legacy_url_request1:
+ summary: Disable legacy URL aliases
+ description: |
+ This request leaves the alias intact but the legacy URL for this alias (http://localhost:5601/s/bills-space/app/dashboards#/view/123) will no longer function. The dashboard still exists and you can access it with the new URL.
+ value:
+ aliases:
+ - targetSpace: bills-space
+ targetType: dashboard
+ sourceId: 123
+ resolve_copy_saved_objects_request1:
+ summary: Resolve conflict errors
+ description: |
+ Resolve conflict errors for a data view, visualization, and Canvas workpad by overwriting the existing saved objects. NOTE: If a prior copy attempt resulted in resolvable errors, you must include a retry for each object you want to copy, including any that were returned in the successResults array. In this example, we retried copying the dashboard accordingly.
+ value:
+ objects:
+ - type: dashboard
+ id: my-dashboard
+ includeReferences: true
+ createNewCopies: false
+ retries:
+ sales:
+ - type: index-pattern
+ id: my-pattern
+ overwrite: true
+ - type: visualization
+ id: my-vis
+ overwrite: true,
+ destinationId: another-vis
+ - type: canvas
+ id: my-canvas
+ overwrite: true
+ destinationId: yet-another-canvas
+ - type: dashboard
+ id: my-dashboard
+ resolve_copy_saved_objects_request2:
+ summary: Resolve missing reference errors
+ description: |
+ Resolve missing reference errors for a visualization by ignoring the error. NOTE: If a prior copy attempt resulted in resolvable errors, you must include a retry for each object you want to copy, including any that were returned in the successResults array. In this example, we retried copying the dashboard and canvas accordingly.
+ value:
+ objects:
+ - type: dashboard
+ id: my-dashboard
+ includeReferences: true
+ createNewCopies: false
+ retries:
+ marketing:
+ - type: visualization
+ id: my-vis
+ ignoreMissingReferences: true
+ - type: canvas
+ id: my-canvas
+ - type: dashboard
+ id: my-dashboard
+ update_saved_objects_spaces_request1:
+ summary: Update saved object spaces
+ description: Update the spaces of each saved object and all its references.
+ value:
+ objects:
+ - type: index-pattern
+ id: 90943e30-9a47-11e8-b64d-95841ca0b247
+ spacesToAdd:
+ - test
+ spacesToRemove: []
+ update_saved_objects_spaces_response1:
+ summary: Update saved object spaces
+ description: |
+ The response from updating the spaces of saved objects.
+ value:
+ objects:
+ - type: index-pattern
+ id: 90943e30-9a47-11e8-b64d-95841ca0b247
+ spaces:
+ - default
+ - test
+ get_spaces_response1:
+ summary: Get all spaces
+ description: Get all spaces without specifying any options.
+ value:
+ - id: default
+ name: Default
+ description: This is the Default Space
+ disabledFeatures: []
+ imageUrl: ''
+ _reserved: true
+ - id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ disabledFeatures:
+ - apm
+ initials: MK
+ imageUrl: data:image/png;base64,iVBORw0KGgoAAAANSU
+ - id: sales
+ name: Sales
+ initials: MK
+ disabledFeatures:
+ - discover
+ imageUr": ''
+ solution: oblt
+ get_spaces_response2:
+ summary: Get all spaces with custom options
+ description: |
+ The user has read-only access to the Sales space. Get all spaces with the following query parameters: "purpose=shareSavedObjectsIntoSpace&include_authorized_purposes=true"
+ value:
+ - id: default
+ name: Default
+ description: This is the Default Space
+ disabledFeatures: []
+ imageUrl: ''
+ _reserved: true
+ authorizedPurposes:
+ any: true
+ copySavedObjectsIntoSpace: true
+ findSavedObjects: true
+ shareSavedObjectsIntoSpace: true
+ - id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ disabledFeatures:
+ - apm
+ initials: MK
+ imageUrl: data:image/png;base64,iVBORw0KGgoAAAANSU
+ authorizedPurposes:
+ any: true
+ copySavedObjectsIntoSpace: true
+ findSavedObjects: true
+ shareSavedObjectsIntoSpace: true
+ - id: sales
+ name: Sales
+ initials: MK
+ disabledFeatures:
+ - discover
+ imageUrl: ''
+ authorizedPurposes:
+ any: true
+ copySavedObjectsIntoSpace: false
+ findSavedObjects: true
+ shareSavedObjectsIntoSpace: false
+ create_space_request:
+ summary: Create a marketing space
+ value:
+ id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ initials: MK
+ disabledFeatures: []
+ imageUrl: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAD4AAABACAYAAABC6cT1AAAGf0lEQVRoQ+3abYydRRUH8N882xYo0IqagEVjokQJKAiKBjXExC9G/aCkGowCIghCkRcrVSSKIu/FEiqgGL6gBIlAYrAqUTH6hZgQFVEMKlQFfItWoQWhZe8z5uzMLdvbfbkLxb13d+fbvfe588x/zpn/+Z9zJpmnI81T3BaAzzfLL1h8weLzZAcWXH2eGHo7zAWLL1h8nuzAjFw9G1N6Kzq8HnuM36MR8iibF3Fv4q+7cv8yDV6K13bYq2furSP8Ag8ncr/vnSnwRViJT2GfCV7yL1yHGxLb+l3EdM9lluNEnIC9xz+f2ZL4Er6Z2DrdXN3fZwp8CU7OfDHxggle8lTLbQ1nJ/7Z7yKmey5zYGZt4h2IzR8/trRc2PDlxJPTzfVcgJ+CC0wMPOa9F6cm7up3EVM9V9386MxliVdM8GwAv6hh/awCz/w7lY25OtF5ruBz4ZLP42NYNrDAFbC3YPWuILnMAfgq3oaRQQYea/stViV+sgssvjKzLvGySeaaNVfP4d7Btokgvxj/bblgpueuF1hmWcyTCmfE3J3M1lTcv0vMswM88zR+jpw4osu6me8kzkpsfLZWzxyRuabO22buxxOJ12FxnXfWgEe83pB5sOE47BsLymzscOoi7nw2JJfZreUjiUsTyzKPZm5NvBDvSuw268AzNzV8H5/Am+qCnsAXgpgSW2Zq9cyKlksbPlTd+te4quWNieMHBfiNDdciYnwsdI/MaOaWhnMTf54J8CqNj8x8JXFIZltYu+HqlmNT8YSBsHgAPw/vxvlVV4du/s0oaxbxg0TbL/jMni0nNcVjQq7+HZfgtpbzBg342TgQ63AkmsymxBW4IjE6A+D7Vzd/fyWxIM/VuCe+HzTgZ2Jpy/kNJ2FJLmLm24mPJ/42A+Bvrxt4SISwlhsaPodH26LZB8rVA3inwwebsrixJCZzX+KMxI/7AV61eVh3DV6Mx3EOvh4kN6jAg8nfUCXm4d1wE66OyxNPTQc+s3/o/MoXizL3JE5O3F3P/uBZPPF4Zr+Wi5uSO48ZPRdyCwn7YB/A35m5KhWNHox4fcNnIs0ddOCRSBxf8+cQG+Huf0l8NJVYP+nI7NXy2ar4QqIGm69JfKPOE2w/mBavCzwM11R2D+ChsUO7hyUfmwx55qDM1xJvqZ7y08TpifuGBfjeURVJnNIVGpkNiXNS0ds7jcySDitDCCWW56LJ10fRo8sNA+3qXUSZD2CtQlZh9T+1rB7h9oliembflnMbzqgSNZKbKGHdPm7OwXb1CvQ1metSETMpszmzvikCJNh/h5E5PHNl4qga/+/cxqrdeWDYgIe7X5L4cGJPJX2940lOX8pD41FnFnc4riluvQKbK0dcHJFi2IBHNTQSlguru4d2/wPOTNzRA3x5y+U1E1uqWDkETOT026XuUJzx6u7ReLhSYenQ7uHua0fKZmwfmcPqsQjxE5WVONcRxn7X89zgn/EKPMRMxOVQXmP18Mx3q3b/Y/0cQE/IhFtHESMsHFlZ1Ml3CH3DZPHImY+pxcKumNmYirtvqMBfhMuU6s3iqOQkTsMPe1tCQwO8Ajs0lxr7W+vnp1MJc9EgCNd/cy6x+9D4veXmprj5wxMw/3C4egW6zzgZOlYZzfwo3F2J7ael0pJamvlPKgWNKFft1AAcKotXoFEbD7kaoSoQPVKB35+5KHF0lai/rJo+up87jWEE/qqqwY+qrL21LWLm95lPJ16ppKw31XC3PXYPJauPEx7B6BHCgrSizRs18qiaRp8tlN3ueCTYPHH9RNaunjI8Z7wLYpT3jZSCYXQ8e9vTsRE/q+no3XMKeObgGtaintbb/AvXj4JDkNw/5hrwYPfIvlZFUbLn7G5q+eQIN09Vnho6cqvnM/Lt99RixH49wO8K0ZL41WTWHoQzvsNVkOheZqKhEGpsp3SzB+BBtZAYve7uOR9tuTaaB6l0XScdYfEQPpkTUyHEGP+XqyDBzu+NBCITUjNWHynkrbWKOuWFn1xKzqsyx0bdvS78odp0+N503Zao0uCsWuSIDku8/7EO60b41vN5+Ses9BKlTdvd8bhp9EBvJjWJAIn/vxwHe6b3tSk6JFPV4nq85oAOrx555v/x/rh3E6Lo+bnuNS4uB4Cuq0ZfvO8X1rM6q/+vnjLVqZq7v83onttc2oYF4HPJmv1gWbB4P7s0l55ZsPhcsmY/WBYs3s8uzaVn5q3F/wf70mRuBCtbjQAAAABJRU5ErkJggg==
+ get_space_response:
+ summary: Get details about a marketing space
+ value:
+ id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ initials: MK
+ disabledFeatures: []
+ imageUrl: ''
+ solution: es
+ update_space_request:
+ summary: Update a marketing space
+ description: Update the marketing space to remove the imageUrl.
+ value:
+ id: marketing
+ name: Marketing
+ description: This is the Marketing Space
+ color: null
+ initials: MK
+ disabledFeatures: []
+ imageUrl: ''
parameters:
Alerting_kbn_xsrf:
description: Cross-site request forgery protection
@@ -43424,10 +42737,8 @@ components:
example: 09f0c261e39e36351d75995b78bb83673774d1bc2cca9df2d15f0e5c0a99a540
type: string
Cases_assignees_filter:
- description: >
- Filters the returned cases by assignees. Valid values are `none` or
- unique identifiers for the user profiles. These identifiers can be found
- by using the suggest user profile API.
+ description: |
+ Filters the returned cases by assignees. Valid values are `none` or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API.
in: query
name: assignees
schema:
@@ -43435,9 +42746,7 @@ components:
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_case_id:
- description: >-
- The identifier for the case. To retrieve case IDs, use the find cases
- API. All non-ASCII characters must be URL encoded.
+ description: The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded.
in: path
name: caseId
required: true
@@ -43453,9 +42762,8 @@ components:
- $ref: '#/components/schemas/Cases_case_category'
- $ref: '#/components/schemas/Cases_case_categories'
Cases_comment_id:
- description: >
- The identifier for the comment. To retrieve comment IDs, use the get
- case or find cases APIs.
+ description: |
+ The identifier for the comment. To retrieve comment IDs, use the get case or find cases APIs.
in: path
name: commentId
required: true
@@ -43471,9 +42779,7 @@ components:
example: 3297a0f0-b5ec-11ec-b141-0fdb20a7f9a9
type: string
Cases_connector_id:
- description: >-
- An identifier for the connector. To retrieve connector IDs, use the find
- connectors API.
+ description: An identifier for the connector. To retrieve connector IDs, use the find connectors API.
in: path
name: connectorId
required: true
@@ -43489,18 +42795,16 @@ components:
default: OR
type: string
Cases_from:
- description: >
- Returns only cases that were created after a specific date. The date
- must be specified as a KQL data range or date match expression.
+ description: |
+ Returns only cases that were created after a specific date. The date must be specified as a KQL data range or date match expression.
in: query
name: from
schema:
example: now-1d
type: string
Cases_ids:
- description: >
- The cases that you want to removed. All non-ASCII characters must be URL
- encoded.
+ description: |
+ The cases that you want to removed. All non-ASCII characters must be URL encoded.
example: d4e7abb0-b462-11ec-9a8d-698504725a43
in: query
name: ids
@@ -43513,9 +42817,7 @@ components:
type: array
Cases_includeComments:
deprecated: true
- description: >-
- Deprecated in 8.1.0. This parameter is deprecated and will be removed in
- a future release. It determines whether case comments are returned.
+ description: Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It determines whether case comments are returned.
in: query
name: includeComments
schema:
@@ -43529,10 +42831,8 @@ components:
schema:
type: string
Cases_owner_filter:
- description: >
- A filter to limit the response to a specific set of applications. If
- this parameter is omitted, the response contains information about all
- the cases that the user has access to read.
+ description: |
+ A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read.
example: cases
in: query
name: owner
@@ -43567,9 +42867,7 @@ components:
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_search:
- description: >-
- An Elasticsearch simple_query_string query that filters the objects in
- the response.
+ description: An Elasticsearch simple_query_string query that filters the objects in the response.
in: query
name: search
schema:
@@ -43641,9 +42939,8 @@ components:
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_to:
- description: >
- Returns only cases that were created before a specific date. The date
- must be specified as a KQL data range or date match expression.
+ description: |
+ Returns only cases that were created before a specific date. The date must be specified as a KQL data range or date match expression.
example: now+1d
in: query
name: to
@@ -43698,9 +42995,7 @@ components:
example: ff959d40-b880-11e8-a6d9-e546fe2bba5f
type: string
Machine_learning_APIs_simulateParam:
- description: >-
- When true, simulates the synchronization by returning only the list of
- actions that would be performed.
+ description: When true, simulates the synchronization by returning only the list of actions that would be performed.
example: 'true'
in: query
name: simulate
@@ -43722,9 +43017,7 @@ components:
schema:
type: string
Saved_objects_saved_object_type:
- description: >-
- Valid options include `visualization`, `dashboard`, `search`,
- `index-pattern`, `config`.
+ description: Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`.
in: path
name: type
required: true
@@ -43746,9 +43039,7 @@ components:
example: 9c235211-6834-11ea-a78c-6feb38a34414
type: string
SLOs_space_id:
- description: >-
- An identifier for the space. If `/s/` and the identifier are omitted
- from the path, the default space is used.
+ description: An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used.
in: path
name: spaceId
required: true
@@ -43866,15 +43157,11 @@ components:
description: Indicates whether it is a dynamic field mapping.
type: boolean
format:
- description: >
- Indicates the format of the field. For example, if the `type` is
- `date_range`, the `format` can be
- `epoch_millis||strict_date_optional_time`.
+ description: |
+ Indicates the format of the field. For example, if the `type` is `date_range`, the `format` can be `epoch_millis||strict_date_optional_time`.
type: string
ignore_above:
- description: >-
- Specifies the maximum length of a string field. Longer strings are
- not indexed or stored.
+ description: Specifies the maximum length of a string field. Longer strings are not indexed or stored.
type: integer
index:
description: Indicates whether field values are indexed.
@@ -43889,18 +43176,15 @@ components:
type:
description: The data type for each object property.
type: string
- description: >
- Details about the object properties. This property is applicable
- when `type` is `object`.
+ description: |
+ Details about the object properties. This property is applicable when `type` is `object`.
type: object
required:
description: Indicates whether the field is required.
type: boolean
scaling_factor:
- description: >
- The scaling factor to use when encoding values. This property is
- applicable when `type` is `scaled_float`. Values will be multiplied
- by this factor at index time and rounded to the closest long value.
+ description: |
+ The scaling factor to use when encoding values. This property is applicable when `type` is `scaled_float`. Values will be multiplied by this factor at index time and rounded to the closest long value.
type: integer
type:
description: Specifies the data type for the field.
@@ -44223,10 +43507,8 @@ components:
example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85
type: string
mark_as_applied_by_agent:
- description: >
- `markAsAppliedByAgent=true` means "force setting it to true
- regardless of etag".
-
+ description: |
+ `markAsAppliedByAgent=true` means "force setting it to true regardless of etag".
This is needed for Jaeger agent that doesn't have etags
type: boolean
service:
@@ -44341,9 +43623,7 @@ components:
type: object
properties:
bundle_filepath:
- description: >-
- The absolute path of the final bundle as used in the web
- application.
+ description: The absolute path of the final bundle as used in the web application.
type: string
service_name:
description: The name of the service that the service map should apply to.
@@ -44352,11 +43632,9 @@ components:
description: The version of the service that the service map should apply to.
type: string
sourcemap:
- description: >
+ description: |
The source map. String or file upload. It must follow the
-
- [source map revision 3
- proposal](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k).
+ [source map revision 3 proposal](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k).
format: binary
type: string
required:
@@ -44435,9 +43713,7 @@ components:
- type
title: Add case comment request properties for alerts
Cases_add_case_comment_request:
- description: >-
- The add comment to case API request body varies depending on whether you
- are adding an alert or a comment.
+ description: The add comment to case API request body varies depending on whether you are adding an alert or a comment.
discriminator:
mapping:
alert: '#/components/schemas/Cases_add_alert_comment_request_properties'
@@ -44447,6 +43723,20 @@ components:
- $ref: '#/components/schemas/Cases_add_alert_comment_request_properties'
- $ref: '#/components/schemas/Cases_add_user_comment_request_properties'
title: Add case comment request
+ Cases_add_case_file_request:
+ description: Defines the file that will be attached to the case. Optional parameters will be generated automatically from the file metadata if not defined.
+ type: object
+ properties:
+ file:
+ description: The file being attached to the case.
+ format: binary
+ type: string
+ filename:
+ description: The desired name of the file being attached to the case, it can be different than the name of the file in the filesystem. **This should not include the file extension.**
+ type: string
+ required:
+ - file
+ title: Add case file request properties
Cases_add_user_comment_request_properties:
description: Defines properties for case comment requests when type is user.
properties:
@@ -44591,16 +43881,8 @@ components:
required:
- type
Cases_alert_identifiers:
- description: >
- The alert identifiers. It is required only when `type` is `alert`. You
- can use an array of strings to add multiple alerts to a case, provided
- that they all relate to the same rule; `index` must also be an array
- with the same length or number of elements. Adding multiple alerts in
- this manner is recommended rather than calling the API multiple times.
- This functionality is in technical preview and may be changed or removed
- in a future release. Elastic will work to fix any issues, but features
- in technical preview are not subject to the support SLA of official GA
- features.
+ description: |
+ The alert identifiers. It is required only when `type` is `alert`. You can use an array of strings to add multiple alerts to a case, provided that they all relate to the same rule; `index` must also be an array with the same length or number of elements. Adding multiple alerts in this manner is recommended rather than calling the API multiple times. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
example: 6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42
oneOf:
- type: string
@@ -44611,15 +43893,8 @@ components:
title: Alert identifiers
x-state: Technical preview
Cases_alert_indices:
- description: >
- The alert indices. It is required only when `type` is `alert`. If you
- are adding multiple alerts to a case, use an array of strings; the
- position of each index name in the array must match the position of the
- corresponding alert identifier in the `alertId` array. This
- functionality is in technical preview and may be changed or removed in a
- future release. Elastic will work to fix any issues, but features in
- technical preview are not subject to the support SLA of official GA
- features.
+ description: |
+ The alert indices. It is required only when `type` is `alert`. If you are adding multiple alerts to a case, use an array of strings; the position of each index name in the array must match the position of the corresponding alert identifier in the `alertId` array. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
oneOf:
- type: string
- items:
@@ -44646,9 +43921,7 @@ components:
type: object
properties:
uid:
- description: >-
- A unique identifier for the user profile. These identifiers can be
- found by using the suggest user profile API.
+ description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
type: string
required:
@@ -44778,25 +44051,19 @@ components:
type: object
properties:
key:
- description: >
- The unique identifier for the custom field. The key value must
- exist in the case configuration settings.
+ description: |
+ The unique identifier for the custom field. The key value must exist in the case configuration settings.
type: string
type:
- description: >
- The custom field type. It must match the type specified in the
- case configuration settings.
+ description: |
+ The custom field type. It must match the type specified in the case configuration settings.
enum:
- text
- toggle
type: string
value:
- description: >
- The custom field value. If the custom field is required, it
- cannot be explicitly set to null. However, for cases that
- existed when the required custom field was added, the default
- value stored in Elasticsearch is `undefined`. The value
- returned in the API and user interface in this case is `null`.
+ description: |
+ The custom field value. If the custom field is required, it cannot be explicitly set to null. However, for cases that existed when the required custom field was added, the default value stored in Elasticsearch is `undefined`. The value returned in the API and user interface in this case is `null`.
oneOf:
- maxLength: 160
minLength: 1
@@ -44808,11 +44075,8 @@ components:
example: A case description.
type: string
duration:
- description: >
- The elapsed time from the creation of the case to its closure (in
- seconds). If the case has not been closed, the duration is set to
- null. If the case was closed after less than half a second, the
- duration is rounded down to zero.
+ description: |
+ The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.
example: 120
nullable: true
type: integer
@@ -44940,9 +44204,8 @@ components:
- open
type: string
Cases_case_tags:
- description: >
- The words and phrases that help categorize cases. It can be an empty
- array.
+ description: |
+ The words and phrases that help categorize cases. It can be an empty array.
items:
maxLength: 256
type: string
@@ -44953,10 +44216,7 @@ components:
maxLength: 160
type: string
Cases_closure_types:
- description: >-
- Indicates whether a case is automatically closed when it is pushed to
- external systems (`close-by-pushing`) or not automatically closed
- (`close-by-user`).
+ description: Indicates whether a case is automatically closed when it is pushed to external systems (`close-by-pushing`) or not automatically closed (`close-by-user`).
enum:
- close-by-pushing
- close-by-user
@@ -44971,9 +44231,7 @@ components:
nullable: true
type: string
id:
- description: >-
- The identifier for the connector. To retrieve connector IDs, use the
- find connectors API.
+ description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
type: string
name:
description: The name of the connector.
@@ -44995,9 +44253,7 @@ components:
type: object
properties:
fields:
- description: >-
- An object containing the connector fields. If you want to omit any
- individual field, specify null as its value.
+ description: An object containing the connector fields. If you want to omit any individual field, specify null as its value.
type: object
properties:
issueType:
@@ -45017,9 +44273,7 @@ components:
- parent
- priority
id:
- description: >-
- The identifier for the connector. To retrieve connector IDs, use the
- find connectors API.
+ description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
type: string
name:
description: The name of the connector.
@@ -45041,30 +44295,20 @@ components:
type: object
properties:
fields:
- description: >-
- An object containing the connector fields. To create a case without
- a connector, specify null. To update a case to remove the connector,
- specify null.
+ description: An object containing the connector fields. To create a case without a connector, specify null. To update a case to remove the connector, specify null.
example: null
nullable: true
type: string
id:
- description: >-
- The identifier for the connector. To create a case without a
- connector, use `none`. To update a case to remove the connector,
- specify `none`.
+ description: The identifier for the connector. To create a case without a connector, use `none`. To update a case to remove the connector, specify `none`.
example: none
type: string
name:
- description: >-
- The name of the connector. To create a case without a connector, use
- `none`. To update a case to remove the connector, specify `none`.
+ description: The name of the connector. To create a case without a connector, use `none`. To update a case to remove the connector, specify `none`.
example: none
type: string
type:
- description: >-
- The type of connector. To create a case without a connector, use
- `.none`. To update a case to remove the connector, specify `.none`.
+ description: The type of connector. To create a case without a connector, use `.none`. To update a case to remove the connector, specify `.none`.
enum:
- .none
example: .none
@@ -45080,9 +44324,7 @@ components:
type: object
properties:
fields:
- description: >-
- An object containing the connector fields. If you want to omit any
- individual field, specify null as its value.
+ description: An object containing the connector fields. If you want to omit any individual field, specify null as its value.
nullable: true
type: object
properties:
@@ -45120,9 +44362,7 @@ components:
type: object
properties:
fields:
- description: >-
- An object containing the connector fields. If you want to omit any
- individual field, specify null as its value.
+ description: An object containing the connector fields. If you want to omit any individual field, specify null as its value.
type: object
properties:
category:
@@ -45152,9 +44392,7 @@ components:
- subcategory
- urgency
id:
- description: >-
- The identifier for the connector. To retrieve connector IDs, use the
- find connectors API.
+ description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
type: string
name:
description: The name of the connector.
@@ -45176,9 +44414,7 @@ components:
type: object
properties:
fields:
- description: >-
- An object containing the connector fields. If you want to omit any
- individual field, specify null as its value.
+ description: An object containing the connector fields. If you want to omit any individual field, specify null as its value.
type: object
properties:
category:
@@ -45186,21 +44422,15 @@ components:
nullable: true
type: string
destIp:
- description: >-
- Indicates whether cases will send a comma-separated list of
- destination IPs.
+ description: Indicates whether cases will send a comma-separated list of destination IPs.
nullable: true
type: boolean
malwareHash:
- description: >-
- Indicates whether cases will send a comma-separated list of
- malware hashes.
+ description: Indicates whether cases will send a comma-separated list of malware hashes.
nullable: true
type: boolean
malwareUrl:
- description: >-
- Indicates whether cases will send a comma-separated list of
- malware URLs.
+ description: Indicates whether cases will send a comma-separated list of malware URLs.
nullable: true
type: boolean
priority:
@@ -45208,9 +44438,7 @@ components:
nullable: true
type: string
sourceIp:
- description: >-
- Indicates whether cases will send a comma-separated list of
- source IPs.
+ description: Indicates whether cases will send a comma-separated list of source IPs.
nullable: true
type: boolean
subcategory:
@@ -45226,9 +44454,7 @@ components:
- sourceIp
- subcategory
id:
- description: >-
- The identifier for the connector. To retrieve connector IDs, use the
- find connectors API.
+ description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
type: string
name:
description: The name of the connector.
@@ -45250,9 +44476,7 @@ components:
type: object
properties:
fields:
- description: >-
- An object containing the connector fields. If you want to omit any
- individual field, specify null as its value.
+ description: An object containing the connector fields. If you want to omit any individual field, specify null as its value.
type: object
properties:
caseId:
@@ -45262,9 +44486,7 @@ components:
required:
- caseId
id:
- description: >-
- The identifier for the connector. To retrieve connector IDs, use the
- find connectors API.
+ description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
type: string
name:
description: The name of the connector.
@@ -45294,9 +44516,7 @@ components:
example: .none
type: string
Cases_create_case_request:
- description: >-
- The create case API request body varies depending on the type of
- connector.
+ description: The create case API request body varies depending on the type of connector.
properties:
assignees:
$ref: '#/components/schemas/Cases_assignees'
@@ -45312,32 +44532,25 @@ components:
- $ref: '#/components/schemas/Cases_connector_properties_servicenow_sir'
- $ref: '#/components/schemas/Cases_connector_properties_swimlane'
customFields:
- description: >
- Custom field values for a case. Any optional custom fields that are
- not specified in the request are set to null.
+ description: |
+ Custom field values for a case. Any optional custom fields that are not specified in the request are set to null.
items:
type: object
properties:
key:
- description: >
- The unique identifier for the custom field. The key value must
- exist in the case configuration settings.
+ description: |
+ The unique identifier for the custom field. The key value must exist in the case configuration settings.
type: string
type:
- description: >
- The custom field type. It must match the type specified in the
- case configuration settings.
+ description: |
+ The custom field type. It must match the type specified in the case configuration settings.
enum:
- text
- toggle
type: string
value:
- description: >
- The custom field value. If the custom field is required, it
- cannot be explicitly set to null. However, for cases that
- existed when the required custom field was added, the default
- value stored in Elasticsearch is `undefined`. The value
- returned in the API and user interface in this case is `null`.
+ description: |
+ The custom field value. If the custom field is required, it cannot be explicitly set to null. However, for cases that existed when the required custom field was added, the default value stored in Elasticsearch is `undefined`. The value returned in the API and user interface in this case is `null`.
oneOf:
- maxLength: 160
minLength: 1
@@ -45409,9 +44622,8 @@ components:
nullable: true
type: string
Cases_owner:
- description: >
- The application that owns the cases: Stack Management, Observability, or
- Elastic Security.
+ description: |
+ The application that owns the cases: Stack Management, Observability, or Elastic Security.
enum:
- cases
- observability
@@ -45471,10 +44683,7 @@ components:
type: object
properties:
fields:
- description: >-
- An object containing the connector fields. To create a case
- without a connector, specify null. If you want to omit any
- individual field, specify null as its value.
+ description: An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.
example: null
nullable: true
type: object
@@ -45483,20 +44692,14 @@ components:
description: The case identifier for Swimlane connectors.
type: string
category:
- description: >-
- The category of the incident for ServiceNow ITSM and
- ServiceNow SecOps connectors.
+ description: The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
type: string
destIp:
- description: >-
- Indicates whether cases will send a comma-separated list of
- destination IPs for ServiceNow SecOps connectors.
+ description: Indicates whether cases will send a comma-separated list of destination IPs for ServiceNow SecOps connectors.
nullable: true
type: boolean
impact:
- description: >-
- The effect an incident had on business for ServiceNow ITSM
- connectors.
+ description: The effect an incident had on business for ServiceNow ITSM connectors.
type: string
issueType:
description: The type of issue for Jira connectors.
@@ -45507,61 +44710,41 @@ components:
type: string
type: array
malwareHash:
- description: >-
- Indicates whether cases will send a comma-separated list of
- malware hashes for ServiceNow SecOps connectors.
+ description: Indicates whether cases will send a comma-separated list of malware hashes for ServiceNow SecOps connectors.
nullable: true
type: boolean
malwareUrl:
- description: >-
- Indicates whether cases will send a comma-separated list of
- malware URLs for ServiceNow SecOps connectors.
+ description: Indicates whether cases will send a comma-separated list of malware URLs for ServiceNow SecOps connectors.
nullable: true
type: boolean
parent:
- description: >-
- The key of the parent issue, when the issue type is sub-task
- for Jira connectors.
+ description: The key of the parent issue, when the issue type is sub-task for Jira connectors.
type: string
priority:
- description: >-
- The priority of the issue for Jira and ServiceNow SecOps
- connectors.
+ description: The priority of the issue for Jira and ServiceNow SecOps connectors.
type: string
severity:
description: The severity of the incident for ServiceNow ITSM connectors.
type: string
severityCode:
- description: >-
- The severity code of the incident for IBM Resilient
- connectors.
+ description: The severity code of the incident for IBM Resilient connectors.
type: string
sourceIp:
- description: >-
- Indicates whether cases will send a comma-separated list of
- source IPs for ServiceNow SecOps connectors.
+ description: Indicates whether cases will send a comma-separated list of source IPs for ServiceNow SecOps connectors.
nullable: true
type: boolean
subcategory:
- description: >-
- The subcategory of the incident for ServiceNow ITSM
- connectors.
+ description: The subcategory of the incident for ServiceNow ITSM connectors.
type: string
urgency:
- description: >-
- The extent to which the incident resolution can be delayed
- for ServiceNow ITSM connectors.
+ description: The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors.
type: string
id:
- description: >-
- The identifier for the connector. To create a case without a
- connector, use `none`.
+ description: The identifier for the connector. To create a case without a connector, use `none`.
example: none
type: string
name:
- description: >-
- The name of the connector. To create a case without a connector,
- use `none`.
+ description: The name of the connector. To create a case without a connector, use `none`.
example: none
type: string
type:
@@ -45575,10 +44758,7 @@ components:
type: object
properties:
fields:
- description: >-
- An object containing the connector fields. To create a case
- without a connector, specify null. If you want to omit any
- individual field, specify null as its value.
+ description: An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.
example: null
nullable: true
type: object
@@ -45587,20 +44767,14 @@ components:
description: The case identifier for Swimlane connectors.
type: string
category:
- description: >-
- The category of the incident for ServiceNow ITSM and
- ServiceNow SecOps connectors.
+ description: The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
type: string
destIp:
- description: >-
- Indicates whether cases will send a comma-separated list of
- destination IPs for ServiceNow SecOps connectors.
+ description: Indicates whether cases will send a comma-separated list of destination IPs for ServiceNow SecOps connectors.
nullable: true
type: boolean
impact:
- description: >-
- The effect an incident had on business for ServiceNow ITSM
- connectors.
+ description: The effect an incident had on business for ServiceNow ITSM connectors.
type: string
issueType:
description: The type of issue for Jira connectors.
@@ -45611,61 +44785,41 @@ components:
type: string
type: array
malwareHash:
- description: >-
- Indicates whether cases will send a comma-separated list of
- malware hashes for ServiceNow SecOps connectors.
+ description: Indicates whether cases will send a comma-separated list of malware hashes for ServiceNow SecOps connectors.
nullable: true
type: boolean
malwareUrl:
- description: >-
- Indicates whether cases will send a comma-separated list of
- malware URLs for ServiceNow SecOps connectors.
+ description: Indicates whether cases will send a comma-separated list of malware URLs for ServiceNow SecOps connectors.
nullable: true
type: boolean
parent:
- description: >-
- The key of the parent issue, when the issue type is sub-task
- for Jira connectors.
+ description: The key of the parent issue, when the issue type is sub-task for Jira connectors.
type: string
priority:
- description: >-
- The priority of the issue for Jira and ServiceNow SecOps
- connectors.
+ description: The priority of the issue for Jira and ServiceNow SecOps connectors.
type: string
severity:
description: The severity of the incident for ServiceNow ITSM connectors.
type: string
severityCode:
- description: >-
- The severity code of the incident for IBM Resilient
- connectors.
+ description: The severity code of the incident for IBM Resilient connectors.
type: string
sourceIp:
- description: >-
- Indicates whether cases will send a comma-separated list of
- source IPs for ServiceNow SecOps connectors.
+ description: Indicates whether cases will send a comma-separated list of source IPs for ServiceNow SecOps connectors.
nullable: true
type: boolean
subcategory:
- description: >-
- The subcategory of the incident for ServiceNow ITSM
- connectors.
+ description: The subcategory of the incident for ServiceNow ITSM connectors.
type: string
urgency:
- description: >-
- The extent to which the incident resolution can be delayed
- for ServiceNow ITSM connectors.
+ description: The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors.
type: string
id:
- description: >-
- The identifier for the connector. To create a case without a
- connector, use `none`.
+ description: The identifier for the connector. To create a case without a connector, use `none`.
example: none
type: string
name:
- description: >-
- The name of the connector. To create a case without a connector,
- use `none`.
+ description: The name of the connector. To create a case without a connector, use `none`.
example: none
type: string
type:
@@ -45689,9 +44843,7 @@ components:
title:
type: string
Cases_payload_delete:
- description: >-
- If the `action` is `delete` and the `type` is `delete_case`, the payload
- is nullable.
+ description: If the `action` is `delete` and the `type` is `delete_case`, the payload is nullable.
nullable: true
type: object
Cases_payload_description:
@@ -45748,12 +44900,8 @@ components:
- user
type: string
Cases_rule:
- description: >
- The rule that is associated with the alerts. It is required only when
- `type` is `alert`. This functionality is in technical preview and may be
- changed or removed in a future release. Elastic will work to fix any
- issues, but features in technical preview are not subject to the support
- SLA of official GA features.
+ description: |
+ The rule that is associated with the alerts. It is required only when `type` is `alert`. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
title: Alerting rule
type: object
properties:
@@ -45777,9 +44925,7 @@ components:
$ref: '#/components/schemas/Cases_searchFieldsType'
type: array
Cases_set_case_configuration_request:
- description: >-
- External connection details, such as the closure type and default
- connector for cases.
+ description: External connection details, such as the closure type and default connector for cases.
properties:
closure_type:
$ref: '#/components/schemas/Cases_closure_types'
@@ -45788,24 +44934,15 @@ components:
type: object
properties:
fields:
- description: >-
- The fields specified in the case configuration are not used and
- are not propagated to individual cases, therefore it is
- recommended to set it to `null`.
+ description: The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to `null`.
nullable: true
type: object
id:
- description: >-
- The identifier for the connector. If you do not want a default
- connector, use `none`. To retrieve connector IDs, use the find
- connectors API.
+ description: The identifier for the connector. If you do not want a default connector, use `none`. To retrieve connector IDs, use the find connectors API.
example: none
type: string
name:
- description: >-
- The name of the connector. If you do not want a default
- connector, use `none`. To retrieve connector names, use the find
- connectors API.
+ description: The name of the connector. If you do not want a default connector, use `none`. To retrieve connector names, use the find connectors API.
example: none
type: string
type:
@@ -45821,18 +44958,14 @@ components:
type: object
properties:
defaultValue:
- description: >
- A default value for the custom field. If the `type` is `text`,
- the default value must be a string. If the `type` is `toggle`,
- the default value must be boolean.
+ description: |
+ A default value for the custom field. If the `type` is `text`, the default value must be a string. If the `type` is `toggle`, the default value must be boolean.
oneOf:
- type: string
- type: boolean
key:
- description: >
- A unique key for the custom field. Must be lower case and
- composed only of a-z, 0-9, '_', and '-' characters. It is used
- in API calls to refer to a specific custom field.
+ description: |
+ A unique key for the custom field. Must be lower case and composed only of a-z, 0-9, '_', and '-' characters. It is used in API calls to refer to a specific custom field.
maxLength: 36
minLength: 1
type: string
@@ -45848,10 +44981,8 @@ components:
- toggle
type: string
required:
- description: >
- Indicates whether the field is required. If `false`, the
- custom field can be set to null or omitted when a case is
- created or updated.
+ description: |
+ Indicates whether the field is required. If `false`, the custom field can be set to null or omitted when a case is created or updated.
type: boolean
required:
- key
@@ -45889,9 +45020,8 @@ components:
maxItems: 100
type: array
Cases_template_tags:
- description: >
- The words and phrases that help categorize templates. It can be an empty
- array.
+ description: |
+ The words and phrases that help categorize templates. It can be an empty array.
items:
maxLength: 256
type: string
@@ -45912,24 +45042,15 @@ components:
type: object
properties:
fields:
- description: >-
- The fields specified in the case configuration are not
- used and are not propagated to individual cases, therefore
- it is recommended to set it to `null`.
+ description: The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to `null`.
nullable: true
type: object
id:
- description: >-
- The identifier for the connector. If you do not want a
- default connector, use `none`. To retrieve connector IDs,
- use the find connectors API.
+ description: The identifier for the connector. If you do not want a default connector, use `none`. To retrieve connector IDs, use the find connectors API.
example: none
type: string
name:
- description: >-
- The name of the connector. If you do not want a default
- connector, use `none`. To retrieve connector names, use
- the find connectors API.
+ description: The name of the connector. If you do not want a default connector, use `none`. To retrieve connector names, use the find connectors API.
example: none
type: string
type:
@@ -45949,11 +45070,8 @@ components:
- toggle
type: string
value:
- description: >
- The default value for the custom field when a case uses
- the template. If the `type` is `text`, the default value
- must be a string. If the `type` is `toggle`, the default
- value must be boolean.
+ description: |
+ The default value for the custom field when a case uses the template. If the `type` is `text`, the default value must be a string. If the `type` is `toggle`, the default value must be boolean.
oneOf:
- type: string
- type: boolean
@@ -45973,10 +45091,8 @@ components:
description: A description for the template.
type: string
key:
- description: >
- A unique key for the template. Must be lower case and composed
- only of a-z, 0-9, '_', and '-' characters. It is used in API calls
- to refer to a specific template.
+ description: |
+ A unique key for the template. Must be lower case and composed only of a-z, 0-9, '_', and '-' characters. It is used in API calls to refer to a specific template.
type: string
name:
description: The name of the template.
@@ -45992,9 +45108,8 @@ components:
alertId:
$ref: '#/components/schemas/Cases_alert_identifiers'
id:
- description: >
- The identifier for the comment. To retrieve comment IDs, use the get
- comments API.
+ description: |
+ The identifier for the comment. To retrieve comment IDs, use the get comments API.
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
type: string
index:
@@ -46010,9 +45125,8 @@ components:
example: alert
type: string
version:
- description: >
- The current comment version. To retrieve version values, use the get
- comments API.
+ description: |
+ The current comment version. To retrieve version values, use the get comments API.
example: Wzk1LDFd
type: string
required:
@@ -46025,9 +45139,7 @@ components:
- version
title: Update case comment request properties for alerts
Cases_update_case_comment_request:
- description: >-
- The update case comment API request body varies depending on whether you
- are updating an alert or a comment.
+ description: The update case comment API request body varies depending on whether you are updating an alert or a comment.
discriminator:
mapping:
alert: '#/components/schemas/Cases_update_alert_comment_request_properties'
@@ -46038,9 +45150,8 @@ components:
- $ref: '#/components/schemas/Cases_update_user_comment_request_properties'
title: Update case comment request
Cases_update_case_configuration_request:
- description: >
- You can update settings such as the closure type, custom fields,
- templates, and the default connector for cases.
+ description: |
+ You can update settings such as the closure type, custom fields, templates, and the default connector for cases.
properties:
closure_type:
$ref: '#/components/schemas/Cases_closure_types'
@@ -46049,24 +45160,15 @@ components:
type: object
properties:
fields:
- description: >-
- The fields specified in the case configuration are not used and
- are not propagated to individual cases, therefore it is
- recommended to set it to `null`.
+ description: The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to `null`.
nullable: true
type: object
id:
- description: >-
- The identifier for the connector. If you do not want a default
- connector, use `none`. To retrieve connector IDs, use the find
- connectors API.
+ description: The identifier for the connector. If you do not want a default connector, use `none`. To retrieve connector IDs, use the find connectors API.
example: none
type: string
name:
- description: >-
- The name of the connector. If you do not want a default
- connector, use `none`. To retrieve connector names, use the find
- connectors API.
+ description: The name of the connector. If you do not want a default connector, use `none`. To retrieve connector names, use the find connectors API.
example: none
type: string
type:
@@ -46082,18 +45184,14 @@ components:
type: object
properties:
defaultValue:
- description: >
- A default value for the custom field. If the `type` is `text`,
- the default value must be a string. If the `type` is `toggle`,
- the default value must be boolean.
+ description: |
+ A default value for the custom field. If the `type` is `text`, the default value must be a string. If the `type` is `toggle`, the default value must be boolean.
oneOf:
- type: string
- type: boolean
key:
- description: >
- A unique key for the custom field. Must be lower case and
- composed only of a-z, 0-9, '_', and '-' characters. It is used
- in API calls to refer to a specific custom field.
+ description: |
+ A unique key for the custom field. Must be lower case and composed only of a-z, 0-9, '_', and '-' characters. It is used in API calls to refer to a specific custom field.
maxLength: 36
minLength: 1
type: string
@@ -46109,10 +45207,8 @@ components:
- toggle
type: string
required:
- description: >
- Indicates whether the field is required. If `false`, the
- custom field can be set to null or omitted when a case is
- created or updated.
+ description: |
+ Indicates whether the field is required. If `false`, the custom field can be set to null or omitted when a case is created or updated.
type: boolean
required:
- key
@@ -46123,9 +45219,8 @@ components:
templates:
$ref: '#/components/schemas/Cases_templates'
version:
- description: >
- The version of the connector. To retrieve the version value, use the
- get configuration API.
+ description: |
+ The version of the connector. To retrieve the version value, use the get configuration API.
example: WzIwMiwxXQ==
type: string
required:
@@ -46133,9 +45228,7 @@ components:
title: Update case configuration request
type: object
Cases_update_case_request:
- description: >-
- The update case API request body varies depending on the type of
- connector.
+ description: The update case API request body varies depending on the type of connector.
properties:
cases:
description: An array containing one or more case objects.
@@ -46149,42 +45242,32 @@ components:
connector:
oneOf:
- $ref: '#/components/schemas/Cases_connector_properties_none'
- - $ref: >-
- #/components/schemas/Cases_connector_properties_cases_webhook
+ - $ref: '#/components/schemas/Cases_connector_properties_cases_webhook'
- $ref: '#/components/schemas/Cases_connector_properties_jira'
- $ref: '#/components/schemas/Cases_connector_properties_resilient'
- $ref: '#/components/schemas/Cases_connector_properties_servicenow'
- - $ref: >-
- #/components/schemas/Cases_connector_properties_servicenow_sir
+ - $ref: '#/components/schemas/Cases_connector_properties_servicenow_sir'
- $ref: '#/components/schemas/Cases_connector_properties_swimlane'
customFields:
- description: >
- Custom field values for a case. Any optional custom fields
- that are not specified in the request are set to null.
+ description: |
+ Custom field values for a case. Any optional custom fields that are not specified in the request are set to null.
items:
type: object
properties:
key:
- description: >
- The unique identifier for the custom field. The key
- value must exist in the case configuration settings.
+ description: |
+ The unique identifier for the custom field. The key value must exist in the case configuration settings.
type: string
type:
- description: >
- The custom field type. It must match the type specified
- in the case configuration settings.
+ description: |
+ The custom field type. It must match the type specified in the case configuration settings.
enum:
- text
- toggle
type: string
value:
- description: >
- The custom field value. If the custom field is required,
- it cannot be explicitly set to null. However, for cases
- that existed when the required custom field was added,
- the default value stored in Elasticsearch is
- `undefined`. The value returned in the API and user
- interface in this case is `null`.
+ description: |
+ The custom field value. If the custom field is required, it cannot be explicitly set to null. However, for cases that existed when the required custom field was added, the default value stored in Elasticsearch is `undefined`. The value returned in the API and user interface in this case is `null`.
oneOf:
- maxLength: 160
minLength: 1
@@ -46215,9 +45298,7 @@ components:
title:
$ref: '#/components/schemas/Cases_case_title'
version:
- description: >-
- The current version of the case. To determine this value, use
- the get case or find cases APIs.
+ description: The current version of the case. To determine this value, use the get case or find cases APIs.
type: string
required:
- id
@@ -46238,9 +45319,8 @@ components:
maxLength: 30000
type: string
id:
- description: >
- The identifier for the comment. To retrieve comment IDs, use the get
- comments API.
+ description: |
+ The identifier for the comment. To retrieve comment IDs, use the get comments API.
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
type: string
owner:
@@ -46252,9 +45332,8 @@ components:
example: user
type: string
version:
- description: >
- The current comment version. To retrieve version values, use the get
- comments API.
+ description: |
+ The current comment version. To retrieve version values, use the get comments API.
example: Wzk1LDFd
type: string
required:
@@ -46486,9 +45565,7 @@ components:
example: Not Found
type: string
message:
- example: >-
- Saved object [index-pattern/caaad6d0-920c-11ed-b36a-874bd1548a00]
- not found
+ example: Saved object [index-pattern/caaad6d0-920c-11ed-b36a-874bd1548a00] not found
type: string
statusCode:
enum:
@@ -46543,9 +45620,7 @@ components:
- title
override:
default: false
- description: >-
- Override an existing data view if a data view with the provided
- title already exists.
+ description: Override an existing data view if a data view with the provided title already exists.
type: boolean
required:
- data_view
@@ -46607,9 +45682,7 @@ components:
description: A map of field formats by field name.
type: object
Data_views_namespaces:
- description: >-
- An array of space identifiers for sharing the data view between multiple
- spaces.
+ description: An array of space identifiers for sharing the data view between multiple spaces.
items:
default: default
type: string
@@ -46661,9 +45734,8 @@ components:
description: The saved object reference to change.
type: string
fromType:
- description: >
- Specify the type of the saved object reference to alter. The default
- value is `index-pattern` for data views.
+ description: |
+ Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views.
type: string
toId:
description: New saved object reference value to replace the old value.
@@ -46675,17 +45747,13 @@ components:
description: The timestamp field name, which you use for time-based data views.
type: string
Data_views_title:
- description: >-
- Comma-separated list of data streams, indices, and aliases that you want
- to search. Supports wildcards (`*`).
+ description: Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (`*`).
type: string
Data_views_type:
description: When set to `rollup`, identifies the rollup data views.
type: string
Data_views_typemeta:
- description: >-
- When you use rollup indices, contains the field list for the rollup data
- view API endpoints.
+ description: When you use rollup indices, contains the field list for the rollup data view API endpoints.
type: object
properties:
aggs:
@@ -46698,9 +45766,7 @@ components:
- aggs
- params
Data_views_typemeta_response:
- description: >-
- When you use rollup indices, contains the field list for the rollup data
- view API endpoints.
+ description: When you use rollup indices, contains the field list for the rollup data view API endpoints.
nullable: true
type: object
properties:
@@ -46715,10 +45781,8 @@ components:
type: object
properties:
data_view:
- description: >
- 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.
+ description: |
+ 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.
type: object
properties:
allowNoIndex:
@@ -46778,10 +45842,7 @@ components:
- status
Kibana_HTTP_APIs_core_status_response:
additionalProperties: false
- description: >-
- Kibana's operational status as well as a detailed breakdown of plugin
- statuses indication of various loads (like event loop utilization and
- network traffic) at time of request.
+ description: Kibana's operational status as well as a detailed breakdown of plugin statuses indication of various loads (like event loop utilization and network traffic) at time of request.
type: object
properties:
metrics:
@@ -46840,9 +45901,7 @@ components:
description: A URL to further documentation regarding this service.
type: string
level:
- description: >-
- Service status levels as human and machine readable
- values.
+ description: Service status levels as human and machine readable values.
enum:
- available
- degraded
@@ -46851,9 +45910,7 @@ components:
type: string
meta:
additionalProperties: {}
- description: >-
- An unstructured set of extra metadata about this
- service.
+ description: An unstructured set of extra metadata about this service.
type: object
summary:
description: A human readable summary of the service status.
@@ -46873,9 +45930,7 @@ components:
description: A URL to further documentation regarding this service.
type: string
level:
- description: >-
- Service status levels as human and machine readable
- values.
+ description: Service status levels as human and machine readable values.
enum:
- available
- degraded
@@ -46884,9 +45939,7 @@ components:
type: string
meta:
additionalProperties: {}
- description: >-
- An unstructured set of extra metadata about this
- service.
+ description: An unstructured set of extra metadata about this service.
type: object
summary:
description: A human readable summary of the service status.
@@ -46939,9 +45992,7 @@ components:
description: A URL to further documentation regarding this service.
type: string
level:
- description: >-
- Service status levels as human and machine readable
- values.
+ description: Service status levels as human and machine readable values.
enum:
- available
- degraded
@@ -46966,9 +46017,7 @@ components:
- core
- plugins
uuid:
- description: >-
- Unique, generated Kibana instance UUID. This UUID should persist
- even if the Kibana process restarts.
+ description: Unique, generated Kibana instance UUID. This UUID should persist even if the Kibana process restarts.
type: string
version:
additionalProperties: false
@@ -46978,24 +46027,16 @@ components:
description: The date and time of this build.
type: string
build_flavor:
- description: >-
- The build flavour determines configuration and behavior of
- Kibana. On premise users will almost always run the
- "traditional" flavour, while other flavours are reserved for
- Elastic-specific use cases.
+ description: The build flavour determines configuration and behavior of Kibana. On premise users will almost always run the "traditional" flavour, while other flavours are reserved for Elastic-specific use cases.
enum:
- serverless
- traditional
type: string
build_hash:
- description: >-
- A unique hash value representing the git commit of this Kibana
- build.
+ description: A unique hash value representing the git commit of this Kibana build.
type: string
build_number:
- description: >-
- A monotonically increasing number, each subsequent build will
- have a higher number.
+ description: A monotonically increasing number, each subsequent build will have a higher number.
type: number
build_snapshot:
description: Whether this build is a snapshot build.
@@ -47021,25 +46062,17 @@ components:
datafeedsAdded:
additionalProperties:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseDatafeeds'
- description: >-
- If a saved object for an anomaly detection job is missing a datafeed
- identifier, it is added when you run the sync machine learning saved
- objects API.
+ description: If a saved object for an anomaly detection job is missing a datafeed identifier, it is added when you run the sync machine learning saved objects API.
type: object
datafeedsRemoved:
additionalProperties:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseDatafeeds'
- description: >-
- If a saved object for an anomaly detection job references a datafeed
- that no longer exists, it is deleted when you run the sync machine
- learning saved objects API.
+ description: If a saved object for an anomaly detection job references a datafeed that no longer exists, it is deleted when you run the sync machine learning saved objects API.
type: object
savedObjectsCreated:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseSavedObjectsCreated
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSavedObjectsCreated'
savedObjectsDeleted:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseSavedObjectsDeleted
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSavedObjectsDeleted'
title: Successful sync API response
type: object
Machine_learning_APIs_mlSync4xxResponse:
@@ -47055,97 +46088,63 @@ components:
title: Unsuccessful sync API response
type: object
Machine_learning_APIs_mlSyncResponseAnomalyDetectors:
- description: >-
- The sync machine learning saved objects API response contains this
- object when there are anomaly detection jobs affected by the
- synchronization. There is an object for each relevant job, which
- contains the synchronization status.
+ description: The sync machine learning saved objects API response contains this object when there are anomaly detection jobs affected by the synchronization. There is an object for each relevant job, which contains the synchronization status.
properties:
success:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSuccess'
title: Sync API response for anomaly detection jobs
type: object
Machine_learning_APIs_mlSyncResponseDatafeeds:
- description: >-
- The sync machine learning saved objects API response contains this
- object when there are datafeeds affected by the synchronization. There
- is an object for each relevant datafeed, which contains the
- synchronization status.
+ description: The sync machine learning saved objects API response contains this object when there are datafeeds affected by the synchronization. There is an object for each relevant datafeed, which contains the synchronization status.
properties:
success:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSuccess'
title: Sync API response for datafeeds
type: object
Machine_learning_APIs_mlSyncResponseDataFrameAnalytics:
- description: >-
- The sync machine learning saved objects API response contains this
- object when there are data frame analytics jobs affected by the
- synchronization. There is an object for each relevant job, which
- contains the synchronization status.
+ description: The sync machine learning saved objects API response contains this object when there are data frame analytics jobs affected by the synchronization. There is an object for each relevant job, which contains the synchronization status.
properties:
success:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSuccess'
title: Sync API response for data frame analytics jobs
type: object
Machine_learning_APIs_mlSyncResponseSavedObjectsCreated:
- description: >-
- If saved objects are missing for machine learning jobs or trained
- models, they are created when you run the sync machine learning saved
- objects API.
+ description: If saved objects are missing for machine learning jobs or trained models, they are created when you run the sync machine learning saved objects API.
properties:
anomaly-detector:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseAnomalyDetectors
- description: >-
- If saved objects are missing for anomaly detection jobs, they are
- created.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseAnomalyDetectors'
+ description: If saved objects are missing for anomaly detection jobs, they are created.
type: object
data-frame-analytics:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseDataFrameAnalytics
- description: >-
- If saved objects are missing for data frame analytics jobs, they are
- created.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseDataFrameAnalytics'
+ description: If saved objects are missing for data frame analytics jobs, they are created.
type: object
trained-model:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseTrainedModels
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseTrainedModels'
description: If saved objects are missing for trained models, they are created.
type: object
title: Sync API response for created saved objects
type: object
Machine_learning_APIs_mlSyncResponseSavedObjectsDeleted:
- description: >-
- If saved objects exist for machine learning jobs or trained models that
- no longer exist, they are deleted when you run the sync machine learning
- saved objects API.
+ description: If saved objects exist for machine learning jobs or trained models that no longer exist, they are deleted when you run the sync machine learning saved objects API.
properties:
anomaly-detector:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseAnomalyDetectors
- description: >-
- If there are saved objects exist for nonexistent anomaly detection
- jobs, they are deleted.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseAnomalyDetectors'
+ description: If there are saved objects exist for nonexistent anomaly detection jobs, they are deleted.
type: object
data-frame-analytics:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseDataFrameAnalytics
- description: >-
- If there are saved objects exist for nonexistent data frame
- analytics jobs, they are deleted.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseDataFrameAnalytics'
+ description: If there are saved objects exist for nonexistent data frame analytics jobs, they are deleted.
type: object
trained-model:
additionalProperties:
- $ref: >-
- #/components/schemas/Machine_learning_APIs_mlSyncResponseTrainedModels
- description: >-
- If there are saved objects exist for nonexistent trained models,
- they are deleted.
+ $ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseTrainedModels'
+ description: If there are saved objects exist for nonexistent trained models, they are deleted.
type: object
title: Sync API response for deleted saved objects
type: object
@@ -47153,11 +46152,7 @@ components:
description: The success or failure of the synchronization.
type: boolean
Machine_learning_APIs_mlSyncResponseTrainedModels:
- description: >-
- The sync machine learning saved objects API response contains this
- object when there are trained models affected by the synchronization.
- There is an object for each relevant trained model, which contains the
- synchronization status.
+ description: The sync machine learning saved objects API response contains this object when there are trained models affected by the synchronization. There is an object for each relevant trained model, which contains the synchronization status.
properties:
success:
$ref: '#/components/schemas/Machine_learning_APIs_mlSyncResponseSuccess'
@@ -47182,32 +46177,16 @@ components:
- message
- statusCode
Saved_objects_attributes:
- description: >
- The data that you want to create. WARNING: When you create saved
- objects, attributes are not validated, which allows you to pass
- arbitrary and ill-formed data into the API that can break Kibana. Make
- sure any data that you send to the API is properly formed.
+ description: |
+ The data that you want to create. WARNING: When you create saved objects, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API that can break Kibana. Make sure any data that you send to the API is properly formed.
type: object
Saved_objects_initial_namespaces:
- description: >
- Identifiers for the spaces in which this object is created. If this is
- provided, the object is created only in the explicitly defined spaces.
- If this is not provided, the object is created in the current space
- (default behavior). For shareable object types (registered with
- `namespaceType: 'multiple'`), this option can be used to specify one or
- more spaces, including the "All spaces" identifier ('*'). For isolated
- object types (registered with `namespaceType: 'single'` or
- `namespaceType: 'multiple-isolated'`), this option can only be used to
- specify a single space, and the "All spaces" identifier ('*') is not
- allowed. For global object types (`registered with `namespaceType:
- agnostic`), this option cannot be used.
+ description: |
+ Identifiers for the spaces in which this object is created. If this is provided, the object is created only in the explicitly defined spaces. If this is not provided, the object is created in the current space (default behavior). For shareable object types (registered with `namespaceType: 'multiple'`), this option can be used to specify one or more spaces, including the "All spaces" identifier ('*'). For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`), this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed. For global object types (`registered with `namespaceType: agnostic`), this option cannot be used.
type: array
Saved_objects_references:
- description: >
- Objects with `name`, `id`, and `type` properties that describe the other
- saved objects that this object references. Use `name` in attributes to
- refer to the other saved object, but never the `id`, which can update
- automatically during migrations or import and export.
+ description: |
+ Objects with `name`, `id`, and `type` properties that describe the other saved objects that this object references. Use `name` in attributes to refer to the other saved object, but never the `id`, which can update automatically during migrations or import and export.
type: array
Security_AI_Assistant_API_AnonymizationFieldCreateProps:
type: object
@@ -47268,8 +46247,7 @@ components:
name:
type: string
skip_reason:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipReason
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipReason'
required:
- id
- skip_reason
@@ -47283,15 +46261,12 @@ components:
properties:
errors:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_NormalizedAnonymizationFieldError
+ $ref: '#/components/schemas/Security_AI_Assistant_API_NormalizedAnonymizationFieldError'
type: array
results:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResults
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResults'
summary:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_BulkCrudActionSummary
+ $ref: '#/components/schemas/Security_AI_Assistant_API_BulkCrudActionSummary'
required:
- results
- summary
@@ -47308,8 +46283,7 @@ components:
properties:
created:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse'
type: array
deleted:
items:
@@ -47317,13 +46291,11 @@ components:
type: array
skipped:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipResult
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipResult'
type: array
updated:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldResponse'
type: array
required:
- updated
@@ -47531,11 +46503,8 @@ components:
type: object
properties:
confidence:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_ConversationConfidence
- description: >-
- How confident you are about this being a correct and useful
- learning.
+ $ref: '#/components/schemas/Security_AI_Assistant_API_ConversationConfidence'
+ description: How confident you are about this being a correct and useful learning.
content:
description: Summary text of the conversation over time.
type: string
@@ -47641,8 +46610,7 @@ components:
properties:
anonymization_fields:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_AnonymizationFieldDetailsInError
+ $ref: '#/components/schemas/Security_AI_Assistant_API_AnonymizationFieldDetailsInError'
type: array
err_code:
type: string
@@ -47663,8 +46631,7 @@ components:
type: string
prompts:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptDetailsInError
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptDetailsInError'
type: array
status_code:
type: integer
@@ -47763,8 +46730,7 @@ components:
name:
type: string
skip_reason:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptsBulkActionSkipReason
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptsBulkActionSkipReason'
required:
- id
- skip_reason
@@ -47776,15 +46742,12 @@ components:
properties:
errors:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_NormalizedPromptError
+ $ref: '#/components/schemas/Security_AI_Assistant_API_NormalizedPromptError'
type: array
results:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptsBulkCrudActionResults
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptsBulkCrudActionResults'
summary:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_BulkCrudActionSummary
+ $ref: '#/components/schemas/Security_AI_Assistant_API_BulkCrudActionSummary'
required:
- results
- summary
@@ -47811,8 +46774,7 @@ components:
type: array
skipped:
items:
- $ref: >-
- #/components/schemas/Security_AI_Assistant_API_PromptsBulkActionSkipResult
+ $ref: '#/components/schemas/Security_AI_Assistant_API_PromptsBulkActionSkipResult'
type: array
updated:
items:
@@ -47966,8 +46928,7 @@ components:
oneOf:
- $ref: '#/components/schemas/Security_Detections_API_AlertsSortCombinations'
- items:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsSortCombinations
+ $ref: '#/components/schemas/Security_Detections_API_AlertsSortCombinations'
type: array
Security_Detections_API_AlertsSortCombinations:
anyOf:
@@ -47985,21 +46946,18 @@ components:
type: object
properties:
duration:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertSuppressionDuration
+ $ref: '#/components/schemas/Security_Detections_API_AlertSuppressionDuration'
group_by:
$ref: '#/components/schemas/Security_Detections_API_AlertSuppressionGroupBy'
missing_fields_strategy:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertSuppressionMissingFieldsStrategy
+ $ref: '#/components/schemas/Security_Detections_API_AlertSuppressionMissingFieldsStrategy'
required:
- group_by
Security_Detections_API_AlertSuppressionDuration:
type: object
properties:
unit:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertSuppressionDurationUnit
+ $ref: '#/components/schemas/Security_Detections_API_AlertSuppressionDurationUnit'
value:
minimum: 1
type: integer
@@ -48019,12 +46977,9 @@ components:
minItems: 1
type: array
Security_Detections_API_AlertSuppressionMissingFieldsStrategy:
- description: >-
- Describes how alerts will be generated for documents with missing
- suppress by fields:
-
+ description: |-
+ Describes how alerts will be generated for documents with missing suppress by fields:
doNotSuppress - per each document a separate alert will be created
-
suppress - only alert will be created per suppress by bucket
enum:
- doNotSuppress
@@ -48051,26 +47006,16 @@ components:
minimum: 0
type: integer
Security_Detections_API_BuildingBlockType:
- description: >-
- Determines if the rule acts as a building block. By default,
- building-block alerts are not displayed in the UI. These rules are used
- as a foundation for other rules that do generate alerts. Its value must
- be default.
+ description: Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
type: string
Security_Detections_API_BulkActionEditPayload:
anyOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadTags
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadIndexPatterns
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadInvestigationFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadTimeline
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadRuleActions
- - $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionEditPayloadSchedule
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadTags'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadIndexPatterns'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadInvestigationFields'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadTimeline'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadRuleActions'
+ - $ref: '#/components/schemas/Security_Detections_API_BulkActionEditPayloadSchedule'
Security_Detections_API_BulkActionEditPayloadIndexPatterns:
type: object
properties:
@@ -48114,12 +47059,10 @@ components:
properties:
actions:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_NormalizedRuleAction
+ $ref: '#/components/schemas/Security_Detections_API_NormalizedRuleAction'
type: array
throttle:
- $ref: >-
- #/components/schemas/Security_Detections_API_ThrottleForBulkActions
+ $ref: '#/components/schemas/Security_Detections_API_ThrottleForBulkActions'
required:
- actions
required:
@@ -48136,9 +47079,7 @@ components:
type: object
properties:
interval:
- description: >-
- Interval in which the rule runs. For example, `"1h"` means the
- rule runs every hour.
+ description: Interval in which the rule runs. For example, `"1h"` means the rule runs every hour.
example: 1h
pattern: ^[1-9]\d*[smh]$
type: string
@@ -48180,8 +47121,7 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
required:
- timeline_id
- timeline_title
@@ -48289,15 +47229,12 @@ components:
properties:
errors:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_NormalizedRuleError
+ $ref: '#/components/schemas/Security_Detections_API_NormalizedRuleError'
type: array
results:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkEditActionResults
+ $ref: '#/components/schemas/Security_Detections_API_BulkEditActionResults'
summary:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkEditActionSummary
+ $ref: '#/components/schemas/Security_Detections_API_BulkEditActionSummary'
required:
- results
- summary
@@ -48539,11 +47476,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -48557,8 +47492,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -48574,24 +47508,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -48618,13 +47548,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -48667,11 +47595,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -48685,8 +47611,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -48702,24 +47627,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -48748,13 +47669,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -48790,11 +47709,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -48808,8 +47725,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -48827,24 +47743,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -48873,13 +47785,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -48898,11 +47808,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -48916,8 +47824,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -48935,24 +47842,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -48981,13 +47884,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -49038,11 +47939,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -49056,8 +47955,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -49073,24 +47971,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -49117,13 +48011,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -49166,11 +48058,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -49184,8 +48074,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -49201,24 +48090,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -49247,13 +48132,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -49278,11 +48161,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -49296,8 +48177,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -49317,13 +48197,11 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
query:
@@ -49332,12 +48210,10 @@ components:
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -49366,13 +48242,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
type:
@@ -49413,11 +48287,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -49431,8 +48303,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -49450,24 +48321,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -49496,13 +48363,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -49527,14 +48392,11 @@ components:
- endpoint_blocklists
type: string
Security_Detections_API_ExternalRuleSource:
- description: >-
- Type of rule source for externally sourced rules, i.e. rules that have
- an external source, such as the Elastic Prebuilt rules repo.
+ description: Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
type: object
properties:
is_customized:
- $ref: >-
- #/components/schemas/Security_Detections_API_IsExternalRuleCustomized
+ $ref: '#/components/schemas/Security_Detections_API_IsExternalRuleCustomized'
type:
enum:
- external
@@ -49589,9 +48451,7 @@ components:
type: string
type: array
Security_Detections_API_InternalRuleSource:
- description: >-
- Type of rule source for internally sourced rules, i.e. created within
- the Kibana apps.
+ description: Type of rule source for internally sourced rules, i.e. created within the Kibana apps.
type: object
properties:
type:
@@ -49601,33 +48461,19 @@ components:
required:
- type
Security_Detections_API_InvestigationFields:
- description: >
- Schema for fields relating to investigation fields. These are user
- defined fields we use to highlight
-
- in various features in the UI such as alert details flyout and
- exceptions auto-population from alert.
-
+ description: |
+ Schema for fields relating to investigation fields. These are user defined fields we use to highlight
+ in various features in the UI such as alert details flyout and exceptions auto-population from alert.
Added in PR #163235
-
- Right now we only have a single field but anticipate adding more related
- fields to store various
-
- configuration states such as `override` - where a user might say if they
- want only these fields to
-
- display, or if they want these fields + the fields we select. When
- expanding this field, it may look
-
+ Right now we only have a single field but anticipate adding more related fields to store various
+ configuration states such as `override` - where a user might say if they want only these fields to
+ display, or if they want these fields + the fields we select. When expanding this field, it may look
something like:
-
```typescript
-
const investigationFields = z.object({
field_names: NonEmptyArray(NonEmptyString),
override: z.boolean().optional(),
});
-
```
type: object
properties:
@@ -49642,19 +48488,14 @@ components:
description: Notes to help investigate alerts produced by the rule.
type: string
Security_Detections_API_IsExternalRuleCustomized:
- description: >-
- Determines whether an external/prebuilt rule has been customized by the
- user (i.e. any of its fields have been modified and diverged from the
- base value).
+ description: Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
type: boolean
Security_Detections_API_IsRuleEnabled:
description: Determines whether the rule is enabled.
type: boolean
Security_Detections_API_IsRuleImmutable:
deprecated: true
- description: >-
- This field determines whether the rule is a prebuilt Elastic rule. It
- will be replaced with the `rule_source` field.
+ description: This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the `rule_source` field.
type: boolean
Security_Detections_API_ItemsPerSearch:
minimum: 1
@@ -49681,11 +48522,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -49699,8 +48538,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -49716,24 +48554,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -49760,13 +48594,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -49795,14 +48627,11 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleResponseFields'
Security_Detections_API_MachineLearningRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields'
Security_Detections_API_MachineLearningRuleCreateProps:
allOf:
- type: object
@@ -49812,11 +48641,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -49830,8 +48657,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -49847,24 +48673,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -49893,13 +48715,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -49909,8 +48729,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleCreateFields'
Security_Detections_API_MachineLearningRuleOptionalFields:
type: object
properties:
@@ -49923,15 +48742,13 @@ components:
anomaly_threshold:
$ref: '#/components/schemas/Security_Detections_API_AnomalyThreshold'
machine_learning_job_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningJobId
+ $ref: '#/components/schemas/Security_Detections_API_MachineLearningJobId'
type:
description: Rule type
enum:
- machine_learning
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields'
Security_Detections_API_MachineLearningRulePatchProps:
allOf:
- type: object
@@ -49941,11 +48758,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -49959,8 +48774,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -49978,24 +48792,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -50024,19 +48834,16 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
$ref: '#/components/schemas/Security_Detections_API_RuleVersion'
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRulePatchFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRulePatchFields'
Security_Detections_API_MachineLearningRuleRequiredFields:
type: object
properties:
@@ -50055,10 +48862,8 @@ components:
- anomaly_threshold
Security_Detections_API_MachineLearningRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleOptionalFields'
Security_Detections_API_MachineLearningRuleUpdateProps:
allOf:
- type: object
@@ -50068,11 +48873,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -50086,8 +48889,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -50105,24 +48907,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -50151,13 +48949,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -50167,8 +48963,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleCreateFields'
Security_Detections_API_MaxSignals:
minimum: 1
type: integer
@@ -50285,11 +49080,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -50303,8 +49096,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -50320,24 +49112,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -50364,13 +49152,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -50399,16 +49185,12 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleResponseFields'
Security_Detections_API_NewTermsRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleDefaultableFields'
Security_Detections_API_NewTermsRuleCreateProps:
allOf:
- type: object
@@ -50418,11 +49200,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -50436,8 +49216,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -50453,24 +49232,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -50499,13 +49274,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -50515,8 +49288,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleCreateFields'
Security_Detections_API_NewTermsRuleDefaultableFields:
type: object
properties:
@@ -50548,10 +49320,8 @@ components:
enum:
- new_terms
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleDefaultableFields'
Security_Detections_API_NewTermsRulePatchProps:
allOf:
- type: object
@@ -50561,11 +49331,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -50579,8 +49347,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -50598,24 +49365,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -50644,13 +49407,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -50677,10 +49438,8 @@ components:
- history_window_start
Security_Detections_API_NewTermsRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleOptionalFields'
- type: object
properties:
language:
@@ -50696,11 +49455,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -50714,8 +49471,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -50733,24 +49489,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -50779,13 +49531,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -50795,8 +49545,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_NewTermsRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleCreateFields'
Security_Detections_API_NonEmptyString:
description: A string that is not empty and does not contain only whitespace
minLength: 1
@@ -50823,8 +49572,7 @@ components:
type: object
properties:
err_code:
- $ref: >-
- #/components/schemas/Security_Detections_API_BulkActionsDryRunErrCode
+ $ref: '#/components/schemas/Security_Detections_API_BulkActionsDryRunErrCode'
message:
type: string
rules:
@@ -50936,11 +49684,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -50954,8 +49700,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -50971,24 +49716,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -51015,13 +49756,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -51055,8 +49794,7 @@ components:
allOf:
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleRequiredFields'
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleOptionalFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_QueryRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_QueryRuleDefaultableFields'
Security_Detections_API_QueryRuleCreateProps:
allOf:
- type: object
@@ -51066,11 +49804,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -51084,8 +49820,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -51101,24 +49836,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -51147,13 +49878,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -51194,8 +49923,7 @@ components:
- query
type: string
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleOptionalFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_QueryRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_QueryRuleDefaultableFields'
Security_Detections_API_QueryRulePatchProps:
allOf:
- type: object
@@ -51205,11 +49933,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -51223,8 +49949,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -51242,24 +49967,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -51288,13 +50009,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -51332,11 +50051,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -51350,8 +50067,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -51369,24 +50085,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -51415,13 +50127,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -51433,58 +50143,32 @@ components:
- severity
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleCreateFields'
Security_Detections_API_RelatedIntegration:
- description: >
- Related integration is a potential dependency of a rule. It's assumed
- that if the user installs
-
- one of the related integrations of a rule, the rule might start to work
- properly because it will
-
- have source events (generated by this integration) potentially matching
- the rule's query.
-
-
- NOTE: Proper work is not guaranteed, because a related integration, if
- installed, can be
-
- configured differently or generate data that is not necessarily relevant
- for this rule.
-
-
- Related integration is a combination of a Fleet package and (optionally)
- one of the
+ description: |
+ Related integration is a potential dependency of a rule. It's assumed that if the user installs
+ one of the related integrations of a rule, the rule might start to work properly because it will
+ have source events (generated by this integration) potentially matching the rule's query.
- package's "integrations" that this package contains. It is represented
- by 3 properties:
+ NOTE: Proper work is not guaranteed, because a related integration, if installed, can be
+ configured differently or generate data that is not necessarily relevant for this rule.
+ Related integration is a combination of a Fleet package and (optionally) one of the
+ package's "integrations" that this package contains. It is represented by 3 properties:
- `package`: name of the package (required, unique id)
-
- `version`: version of the package (required, semver-compatible)
+ - `integration`: name of the integration of this package (optional, id within the package)
- - `integration`: name of the integration of this package (optional, id
- within the package)
-
-
- There are Fleet packages like `windows` that contain only one
- integration; in this case,
-
- `integration` should be unspecified. There are also packages like `aws`
- and `azure` that contain
-
+ There are Fleet packages like `windows` that contain only one integration; in this case,
+ `integration` should be unspecified. There are also packages like `aws` and `azure` that contain
several integrations; in this case, `integration` should be specified.
-
@example
-
const x: RelatedIntegration = {
package: 'windows',
version: '1.5.x',
};
-
@example
-
const x: RelatedIntegration = {
package: 'azure',
version: '~1.1.6',
@@ -51506,35 +50190,23 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RelatedIntegration'
type: array
Security_Detections_API_RequiredField:
- description: >
- Describes an Elasticsearch field that is needed for the rule to
- function.
-
-
- Almost all types of Security rules check source event documents for a
- match to some kind of
-
- query or filter. If a document has certain field with certain values,
- then it's a match and
+ description: |
+ Describes an Elasticsearch field that is needed for the rule to function.
+ Almost all types of Security rules check source event documents for a match to some kind of
+ query or filter. If a document has certain field with certain values, then it's a match and
the rule will generate an alert.
-
- Required field is an event field that must be present in the source
- indices of a given rule.
-
+ Required field is an event field that must be present in the source indices of a given rule.
@example
-
const standardEcsField: RequiredField = {
name: 'event.action',
type: 'keyword',
ecs: true,
};
-
@example
-
const nonEcsField: RequiredField = {
name: 'winlog.event_data.AttributeLDAPDisplayName',
type: 'keyword',
@@ -51560,10 +50232,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RequiredField'
type: array
Security_Detections_API_RequiredFieldInput:
- description: >-
- Input parameters to create a RequiredField. Does not include the `ecs`
- field, because `ecs` is calculated on the backend based on the field
- name and type.
+ description: Input parameters to create a RequiredField. Does not include the `ecs` field, because `ecs` is calculated on the backend based on the field name and type.
type: object
properties:
name:
@@ -51625,9 +50294,7 @@ components:
minimum: 0
type: integer
Security_Detections_API_RiskScoreMapping:
- description: >-
- Overrides generated alerts' risk_score with a value from the source
- event
+ description: Overrides generated alerts' risk_score with a value from the source event
items:
type: object
properties:
@@ -51672,17 +50339,13 @@ components:
additionalProperties: true
type: object
Security_Detections_API_RuleActionFrequency:
- description: >-
- The action frequency defines when the action runs (for example, only on
- rule execution or at specific time intervals).
+ description: The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
type: object
properties:
notifyWhen:
$ref: '#/components/schemas/Security_Detections_API_RuleActionNotifyWhen'
summary:
- description: >-
- Action summary indicates whether we will send a summary notification
- about all the generate alerts or notification per individual alert
+ description: Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
type: boolean
throttle:
$ref: '#/components/schemas/Security_Detections_API_RuleActionThrottle'
@@ -51692,17 +50355,13 @@ components:
- notifyWhen
- throttle
Security_Detections_API_RuleActionGroup:
- description: >-
- Optionally groups actions by use cases. Use `default` for alert
- notifications.
+ description: Optionally groups actions by use cases. Use `default` for alert notifications.
type: string
Security_Detections_API_RuleActionId:
description: The connector ID.
type: string
Security_Detections_API_RuleActionNotifyWhen:
- description: >-
- The condition for throttling the notification: `onActionGroupChange`,
- `onActiveAlert`, or `onThrottleInterval`
+ description: 'The condition for throttling the notification: `onActionGroupChange`, `onActiveAlert`, or `onThrottleInterval`'
enum:
- onActiveAlert
- onThrottleInterval
@@ -51710,9 +50369,7 @@ components:
type: string
Security_Detections_API_RuleActionParams:
additionalProperties: true
- description: >-
- Object containing the allowed connector fields, which varies according
- to the connector type.
+ description: Object containing the allowed connector fields, which varies according to the connector type.
type: object
Security_Detections_API_RuleActionThrottle:
description: Defines how often rule actions are taken.
@@ -51733,14 +50390,10 @@ components:
anyOf:
- $ref: '#/components/schemas/Security_Detections_API_EqlRuleCreateProps'
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleCreateProps'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleCreateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleCreateProps
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleCreateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleCreateProps'
- $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleCreateProps'
- $ref: '#/components/schemas/Security_Detections_API_EsqlRuleCreateProps'
discriminator:
@@ -51787,50 +50440,25 @@ components:
minimum: 0
type: integer
total_enrichment_duration_ms:
- description: >-
- Total time spent enriching documents during current rule execution
- cycle
+ description: Total time spent enriching documents during current rule execution cycle
minimum: 0
type: integer
total_indexing_duration_ms:
- description: >-
- Total time spent indexing documents during current rule execution
- cycle
+ description: Total time spent indexing documents during current rule execution cycle
minimum: 0
type: integer
total_search_duration_ms:
- description: >-
- Total time spent performing ES searches as measured by Kibana;
- includes network latency and time spent serializing/deserializing
- request/response
+ description: Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
minimum: 0
type: integer
Security_Detections_API_RuleExecutionStatus:
- description: >-
- Custom execution status of Security rules that is different from the
- status used in the Alerting Framework. We merge our custom status with
- the Framework's status to determine the resulting status of a rule.
-
- - going to run - @deprecated Replaced by the 'running' status but left
- for backwards compatibility with rule execution events already written
- to Event Log in the prior versions of Kibana. Don't use when writing
- rule status changes.
-
- - running - Rule execution started but not reached any intermediate or
- final status.
-
- - partial failure - Rule can partially fail for various reasons either
- in the middle of an execution (in this case we update its status right
- away) or in the end of it. So currently this status can be both
- intermediate and final at the same time. A typical reason for a partial
- failure: not all the indices that the rule searches over actually exist.
-
- - failed - Rule failed to execute due to unhandled exception or a reason
- defined in the business logic of its executor function.
-
- - succeeded - Rule executed successfully without any issues. Note: this
- status is just an indication of a rule's "health". The rule might or
- might not generate any alerts despite of it.
+ description: |-
+ Custom execution status of Security rules that is different from the status used in the Alerting Framework. We merge our custom status with the Framework's status to determine the resulting status of a rule.
+ - going to run - @deprecated Replaced by the 'running' status but left for backwards compatibility with rule execution events already written to Event Log in the prior versions of Kibana. Don't use when writing rule status changes.
+ - running - Rule execution started but not reached any intermediate or final status.
+ - partial failure - Rule can partially fail for various reasons either in the middle of an execution (in this case we update its status right away) or in the end of it. So currently this status can be both intermediate and final at the same time. A typical reason for a partial failure: not all the indices that the rule searches over actually exist.
+ - failed - Rule failed to execute due to unhandled exception or a reason defined in the business logic of its executor function.
+ - succeeded - Rule executed successfully without any issues. Note: this status is just an indication of a rule's "health". The rule might or might not generate any alerts despite of it.
enum:
- going to run
- running
@@ -51853,14 +50481,12 @@ components:
message:
type: string
metrics:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleExecutionMetrics
+ $ref: '#/components/schemas/Security_Detections_API_RuleExecutionMetrics'
status:
$ref: '#/components/schemas/Security_Detections_API_RuleExecutionStatus'
description: Status of the last execution
status_order:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleExecutionStatusOrder
+ $ref: '#/components/schemas/Security_Detections_API_RuleExecutionStatusOrder'
required:
- date
- status
@@ -51877,16 +50503,10 @@ components:
items: {}
type: array
Security_Detections_API_RuleInterval:
- description: >-
- Frequency of rule execution, using a date math range. For example, "1h"
- means the rule runs every hour. Defaults to 5m (5 minutes).
+ description: Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
type: string
Security_Detections_API_RuleIntervalFrom:
- description: >-
- Time from which data is analyzed each time the rule runs, using a date
- math range. For example, now-4200s means the rule analyzes data from 70
- minutes before its start time. Defaults to now-6m (analyzes data from 6
- minutes before the start time).
+ description: Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
format: date-math
type: string
Security_Detections_API_RuleIntervalTo:
@@ -51909,13 +50529,10 @@ components:
anyOf:
- $ref: '#/components/schemas/Security_Detections_API_EqlRulePatchProps'
- $ref: '#/components/schemas/Security_Detections_API_QueryRulePatchProps'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRulePatchProps
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRulePatchProps'
- $ref: '#/components/schemas/Security_Detections_API_ThresholdRulePatchProps'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRulePatchProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRulePatchProps
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRulePatchProps'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRulePatchProps'
- $ref: '#/components/schemas/Security_Detections_API_NewTermsRulePatchProps'
- $ref: '#/components/schemas/Security_Detections_API_EsqlRulePatchProps'
Security_Detections_API_RulePreviewLoggedRequest:
@@ -51941,8 +50558,7 @@ components:
type: array
requests:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RulePreviewLoggedRequest
+ $ref: '#/components/schemas/Security_Detections_API_RulePreviewLoggedRequest'
type: array
startedAt:
$ref: '#/components/schemas/Security_Detections_API_NonEmptyString'
@@ -51987,19 +50603,14 @@ components:
description: Could be any string, not necessarily a UUID
type: string
Security_Detections_API_RuleSource:
- description: >-
- Discriminated union that determines whether the rule is internally
- sourced (created within the Kibana app) or has an external source, such
- as the Elastic Prebuilt rules repo.
+ description: Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
discriminator:
propertyName: type
oneOf:
- $ref: '#/components/schemas/Security_Detections_API_ExternalRuleSource'
- $ref: '#/components/schemas/Security_Detections_API_InternalRuleSource'
Security_Detections_API_RuleTagArray:
- description: >-
- String array containing words and phrases to help categorize, filter,
- and search rules. Defaults to an empty array.
+ description: String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
items:
type: string
type: array
@@ -52007,14 +50618,10 @@ components:
anyOf:
- $ref: '#/components/schemas/Security_Detections_API_EqlRuleUpdateProps'
- $ref: '#/components/schemas/Security_Detections_API_QueryRuleUpdateProps'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleUpdateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleUpdateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleUpdateProps
- - $ref: >-
- #/components/schemas/Security_Detections_API_MachineLearningRuleUpdateProps
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleUpdateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleUpdateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleUpdateProps'
+ - $ref: '#/components/schemas/Security_Detections_API_MachineLearningRuleUpdateProps'
- $ref: '#/components/schemas/Security_Detections_API_NewTermsRuleUpdateProps'
- $ref: '#/components/schemas/Security_Detections_API_EsqlRuleUpdateProps'
discriminator:
@@ -52047,11 +50654,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -52065,8 +50670,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -52082,24 +50686,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -52126,13 +50726,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -52161,16 +50759,12 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleResponseFields'
Security_Detections_API_SavedQueryRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleDefaultableFields'
Security_Detections_API_SavedQueryRuleCreateProps:
allOf:
- type: object
@@ -52180,11 +50774,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -52198,8 +50790,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -52215,24 +50806,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -52261,13 +50848,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -52277,8 +50862,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleCreateFields'
Security_Detections_API_SavedQueryRuleDefaultableFields:
type: object
properties:
@@ -52308,10 +50892,8 @@ components:
enum:
- saved_query
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleDefaultableFields'
Security_Detections_API_SavedQueryRulePatchProps:
allOf:
- type: object
@@ -52321,11 +50903,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -52339,8 +50919,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -52358,24 +50937,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -52404,19 +50979,16 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
$ref: '#/components/schemas/Security_Detections_API_RuleVersion'
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRulePatchFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRulePatchFields'
Security_Detections_API_SavedQueryRuleRequiredFields:
type: object
properties:
@@ -52432,10 +51004,8 @@ components:
- saved_id
Security_Detections_API_SavedQueryRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleOptionalFields'
- type: object
properties:
language:
@@ -52451,11 +51021,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -52469,8 +51037,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -52488,24 +51055,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -52534,13 +51097,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -52550,8 +51111,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_SavedQueryRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_SavedQueryRuleCreateFields'
Security_Detections_API_SetAlertsStatusByIds:
type: object
properties:
@@ -52667,18 +51227,14 @@ components:
type: array
Security_Detections_API_ThreatFilters:
items:
- description: >-
- Query and filter context array used to filter documents from the
- Elasticsearch index containing the threat values
+ description: Query and filter context array used to filter documents from the Elasticsearch index containing the threat values
type: array
Security_Detections_API_ThreatIndex:
items:
type: string
type: array
Security_Detections_API_ThreatIndicatorPath:
- description: >-
- Defines the path to the threat indicator in the indicator documents
- (optional)
+ description: Defines the path to the threat indicator in the indicator documents (optional)
type: string
Security_Detections_API_ThreatMapping:
items:
@@ -52714,11 +51270,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -52732,8 +51286,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -52749,24 +51302,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -52793,13 +51342,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -52828,16 +51375,12 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleResponseFields'
Security_Detections_API_ThreatMatchRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleDefaultableFields'
Security_Detections_API_ThreatMatchRuleCreateProps:
allOf:
- type: object
@@ -52847,11 +51390,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -52865,8 +51406,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -52882,24 +51422,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -52928,13 +51464,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -52944,8 +51478,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleCreateFields'
Security_Detections_API_ThreatMatchRuleDefaultableFields:
type: object
properties:
@@ -52991,10 +51524,8 @@ components:
enum:
- threat_match
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleDefaultableFields'
Security_Detections_API_ThreatMatchRulePatchProps:
allOf:
- type: object
@@ -53004,11 +51535,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -53022,8 +51551,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -53041,24 +51569,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -53087,19 +51611,16 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
$ref: '#/components/schemas/Security_Detections_API_RuleVersion'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRulePatchFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRulePatchFields'
Security_Detections_API_ThreatMatchRuleRequiredFields:
type: object
properties:
@@ -53124,10 +51645,8 @@ components:
- threat_index
Security_Detections_API_ThreatMatchRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleOptionalFields'
- type: object
properties:
language:
@@ -53143,11 +51662,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -53161,8 +51678,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -53180,24 +51696,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -53226,13 +51738,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -53242,8 +51752,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThreatMatchRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThreatMatchRuleCreateFields'
Security_Detections_API_ThreatQuery:
description: Query to run
type: string
@@ -53316,8 +51825,7 @@ components:
type: object
properties:
duration:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertSuppressionDuration
+ $ref: '#/components/schemas/Security_Detections_API_AlertSuppressionDuration'
required:
- duration
Security_Detections_API_ThresholdCardinality:
@@ -53349,11 +51857,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -53367,8 +51873,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -53384,24 +51889,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -53428,13 +51929,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -53463,16 +51962,12 @@ components:
- related_integrations
- required_fields
- $ref: '#/components/schemas/Security_Detections_API_ResponseFields'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleResponseFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleResponseFields'
Security_Detections_API_ThresholdRuleCreateFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleDefaultableFields'
Security_Detections_API_ThresholdRuleCreateProps:
allOf:
- type: object
@@ -53482,11 +51977,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -53500,8 +51993,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
interval:
@@ -53517,24 +52009,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -53563,13 +52051,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -53579,8 +52065,7 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleCreateFields'
Security_Detections_API_ThresholdRuleDefaultableFields:
type: object
properties:
@@ -53590,8 +52075,7 @@ components:
type: object
properties:
alert_suppression:
- $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdAlertSuppression
+ $ref: '#/components/schemas/Security_Detections_API_ThresholdAlertSuppression'
data_view_id:
$ref: '#/components/schemas/Security_Detections_API_DataViewId'
filters:
@@ -53613,10 +52097,8 @@ components:
enum:
- threshold
type: string
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleDefaultableFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleDefaultableFields'
Security_Detections_API_ThresholdRulePatchProps:
allOf:
- type: object
@@ -53626,11 +52108,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -53644,8 +52124,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -53663,24 +52142,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -53709,19 +52184,16 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
$ref: '#/components/schemas/Security_Detections_API_RuleVersion'
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRulePatchFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRulePatchFields'
Security_Detections_API_ThresholdRuleRequiredFields:
type: object
properties:
@@ -53740,10 +52212,8 @@ components:
- threshold
Security_Detections_API_ThresholdRuleResponseFields:
allOf:
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleRequiredFields
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleRequiredFields'
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleOptionalFields'
- type: object
properties:
language:
@@ -53759,11 +52229,9 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleAction'
type: array
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasPurpose'
alias_target_id:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveAliasTargetId'
author:
$ref: '#/components/schemas/Security_Detections_API_RuleAuthorArray'
building_block_type:
@@ -53777,8 +52245,7 @@ components:
$ref: '#/components/schemas/Security_Detections_API_RuleExceptionList'
type: array
false_positives:
- $ref: >-
- #/components/schemas/Security_Detections_API_RuleFalsePositiveArray
+ $ref: '#/components/schemas/Security_Detections_API_RuleFalsePositiveArray'
from:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalFrom'
id:
@@ -53796,24 +52263,20 @@ components:
name:
$ref: '#/components/schemas/Security_Detections_API_RuleName'
namespace:
- $ref: >-
- #/components/schemas/Security_Detections_API_AlertsIndexNamespace
+ $ref: '#/components/schemas/Security_Detections_API_AlertsIndexNamespace'
note:
$ref: '#/components/schemas/Security_Detections_API_InvestigationGuide'
outcome:
- $ref: >-
- #/components/schemas/Security_Detections_API_SavedObjectResolveOutcome
+ $ref: '#/components/schemas/Security_Detections_API_SavedObjectResolveOutcome'
output_index:
$ref: '#/components/schemas/Security_Detections_API_AlertsIndex'
references:
$ref: '#/components/schemas/Security_Detections_API_RuleReferenceArray'
related_integrations:
- $ref: >-
- #/components/schemas/Security_Detections_API_RelatedIntegrationArray
+ $ref: '#/components/schemas/Security_Detections_API_RelatedIntegrationArray'
required_fields:
items:
- $ref: >-
- #/components/schemas/Security_Detections_API_RequiredFieldInput
+ $ref: '#/components/schemas/Security_Detections_API_RequiredFieldInput'
type: array
response_actions:
items:
@@ -53842,13 +52305,11 @@ components:
timeline_id:
$ref: '#/components/schemas/Security_Detections_API_TimelineTemplateId'
timeline_title:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimelineTemplateTitle
+ $ref: '#/components/schemas/Security_Detections_API_TimelineTemplateTitle'
timestamp_override:
$ref: '#/components/schemas/Security_Detections_API_TimestampOverride'
timestamp_override_fallback_disabled:
- $ref: >-
- #/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled
+ $ref: '#/components/schemas/Security_Detections_API_TimestampOverrideFallbackDisabled'
to:
$ref: '#/components/schemas/Security_Detections_API_RuleIntervalTo'
version:
@@ -53858,16 +52319,13 @@ components:
- description
- risk_score
- severity
- - $ref: >-
- #/components/schemas/Security_Detections_API_ThresholdRuleCreateFields
+ - $ref: '#/components/schemas/Security_Detections_API_ThresholdRuleCreateFields'
Security_Detections_API_ThresholdValue:
description: Threshold value
minimum: 1
type: integer
Security_Detections_API_ThrottleForBulkActions:
- description: >-
- The condition for throttling the notification: 'rule', 'no_actions', or
- time duration
+ description: 'The condition for throttling the notification: ''rule'', ''no_actions'', or time duration'
enum:
- rule
- 1h
@@ -53929,44 +52387,34 @@ components:
created_by:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListDescription'
id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListId'
immutable:
type: boolean
list_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListMeta
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListMeta'
name:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListName
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionNamespaceType'
os_types:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsTypeArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsTypeArray'
tags:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListTags
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListTags'
tie_breaker_id:
type: string
type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListType'
updated_at:
format: date-time
type: string
updated_by:
type: string
version:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListVersion
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListVersion'
required:
- id
- list_id
@@ -53994,51 +52442,39 @@ components:
_version:
type: string
comments:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray'
created_at:
format: date-time
type: string
created_by:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemId'
item_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId'
list_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListHumanId
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListHumanId'
meta:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemMeta'
name:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemName'
namespace_type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionNamespaceType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionNamespaceType'
os_types:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray'
tags:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemTags'
tie_breaker_id:
type: string
type:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemType'
updated_at:
format: date-time
type: string
@@ -54083,31 +52519,23 @@ components:
- created_by
Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemComment
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemComment'
type: array
Security_Endpoint_Exceptions_API_ExceptionListItemDescription:
type: string
Security_Endpoint_Exceptions_API_ExceptionListItemEntry:
anyOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryList
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryNested
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchWildcard
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryList'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryNested'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchWildcard'
discriminator:
propertyName: type
Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntry
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntry'
type: array
Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists:
type: object
@@ -54115,8 +52543,7 @@ components:
field:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- exists
@@ -54141,8 +52568,7 @@ components:
- id
- type
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- list
@@ -54158,8 +52584,7 @@ components:
field:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- match
@@ -54177,16 +52602,14 @@ components:
field:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- match_any
type: string
value:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
minItems: 1
type: array
required:
@@ -54200,8 +52623,7 @@ components:
field:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- wildcard
@@ -54218,8 +52640,7 @@ components:
properties:
entries:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryNestedEntryItem
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryNestedEntryItem'
minItems: 1
type: array
field:
@@ -54234,12 +52655,9 @@ components:
- entries
Security_Endpoint_Exceptions_API_ExceptionListItemEntryNestedEntryItem:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny
- - $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny'
+ - $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists'
Security_Endpoint_Exceptions_API_ExceptionListItemEntryOperator:
enum:
- excluded
@@ -54256,8 +52674,7 @@ components:
$ref: '#/components/schemas/Security_Endpoint_Exceptions_API_NonEmptyString'
Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsType'
type: array
Security_Endpoint_Exceptions_API_ExceptionListItemTags:
items:
@@ -54280,8 +52697,7 @@ components:
type: string
Security_Endpoint_Exceptions_API_ExceptionListOsTypeArray:
items:
- $ref: >-
- #/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsType
+ $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_ExceptionListOsType'
type: array
Security_Endpoint_Exceptions_API_ExceptionListTags:
items:
@@ -54301,15 +52717,11 @@ components:
minimum: 1
type: integer
Security_Endpoint_Exceptions_API_ExceptionNamespaceType:
- description: >
- Determines whether the exception container is available in all Kibana
- spaces or just the space
-
+ description: |
+ Determines whether the exception container is available in all Kibana spaces or just the space
in which it is created, where:
-
- `single`: Only available in the Kibana space in which it is created.
-
- `agnostic`: Available in all Kibana spaces.
enum:
- agnostic
@@ -54398,11 +52810,9 @@ components:
type: object
properties:
agent_id:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_AgentId
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_AgentId'
pending_actions:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionsSchema
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionsSchema'
required:
- agent_id
- pending_actions
@@ -54493,8 +52903,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -54505,11 +52914,9 @@ components:
type: object
properties:
command:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_Command
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_Command'
timeout:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_Timeout
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_Timeout'
required:
- command
required:
@@ -54554,8 +52961,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -54572,11 +52978,9 @@ components:
required:
- parameters
Security_Endpoint_Management_API_GetProcessesRouteRequestBody:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
Security_Endpoint_Management_API_IsolateRouteRequestBody:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
Security_Endpoint_Management_API_KillProcessRouteRequestBody:
allOf:
- type: object
@@ -54590,8 +52994,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -54601,8 +53004,7 @@ components:
parameters:
oneOf:
- $ref: '#/components/schemas/Security_Endpoint_Management_API_Pid'
- - $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EntityId
+ - $ref: '#/components/schemas/Security_Endpoint_Management_API_EntityId'
- type: object
properties:
process_name:
@@ -54678,8 +53080,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -54701,32 +53102,23 @@ components:
- type: object
properties:
execute:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
get-file:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
isolate:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
kill-process:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
running-processes:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
scan:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
suspend-process:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
unisolate:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
upload:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_PendingActionDataType
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_PendingActionDataType'
- additionalProperties: true
type: object
Security_Endpoint_Management_API_Pid:
@@ -54753,8 +53145,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -54789,8 +53180,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -54800,8 +53190,7 @@ components:
parameters:
oneOf:
- $ref: '#/components/schemas/Security_Endpoint_Management_API_Pid'
- - $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EntityId
+ - $ref: '#/components/schemas/Security_Endpoint_Management_API_EntityId'
required:
- parameters
Security_Endpoint_Management_API_Timeout:
@@ -54822,8 +53211,7 @@ components:
minLength: 1
type: array
Security_Endpoint_Management_API_UnisolateRouteRequestBody:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
Security_Endpoint_Management_API_UploadRouteRequestBody:
allOf:
- type: object
@@ -54837,8 +53225,7 @@ components:
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
- $ref: >-
- #/components/schemas/Security_Endpoint_Management_API_EndpointIds
+ $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
@@ -54910,10 +53297,8 @@ components:
type: string
Security_Entity_Analytics_API_AssetCriticalityRecord:
allOf:
- - $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord
- - $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecordEcsParts
+ - $ref: '#/components/schemas/Security_Entity_Analytics_API_CreateAssetCriticalityRecord'
+ - $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecordEcsParts'
- type: object
properties:
'@timestamp':
@@ -54930,8 +53315,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- asset
host:
@@ -54941,8 +53325,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality
name:
@@ -54956,8 +53339,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality
name:
@@ -55002,13 +53384,11 @@ components:
- errors
Security_Entity_Analytics_API_CreateAssetCriticalityRecord:
allOf:
- - $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecordIdParts
+ - $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityRecordIdParts'
- type: object
properties:
criticality_level:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality_level
Security_Entity_Analytics_API_EngineDataviewUpdateResult:
@@ -55082,23 +53462,17 @@ components:
format: double
type: number
calculated_score_norm:
- description: >-
- The normalized numeric value of the given entity's risk score.
- Useful for comparing with other entities.
+ description: The normalized numeric value of the given entity's risk score. Useful for comparing with other entities.
format: double
maximum: 100
minimum: 0
type: number
category_1_count:
- description: >-
- The number of risk input documents that contributed to the Category
- 1 score (`category_1_score`).
+ description: The number of risk input documents that contributed to the Category 1 score (`category_1_score`).
format: integer
type: number
category_1_score:
- description: >-
- The contribution of Category 1 to the overall risk score
- (`calculated_score`). Category 1 contains Detection Engine Alerts.
+ description: The contribution of Category 1 to the overall risk score (`calculated_score`). Category 1 contains Detection Engine Alerts.
format: double
type: number
category_2_count:
@@ -55108,27 +53482,20 @@ components:
format: double
type: number
criticality_level:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
criticality_modifier:
format: double
type: number
id_field:
- description: >-
- The identifier field defining this risk score. Coupled with
- `id_value`, uniquely identifies the entity being scored.
+ description: The identifier field defining this risk score. Coupled with `id_value`, uniquely identifies the entity being scored.
example: host.name
type: string
id_value:
- description: >-
- The identifier value defining this risk score. Coupled with
- `id_field`, uniquely identifies the entity being scored.
+ description: The identifier value defining this risk score. Coupled with `id_field`, uniquely identifies the entity being scored.
example: example.host
type: string
inputs:
- description: >-
- A list of the highest-risk documents contributing to this risk
- score. Useful for investigative purposes.
+ description: A list of the highest-risk documents contributing to this risk score. Useful for investigative purposes.
items:
$ref: '#/components/schemas/Security_Entity_Analytics_API_RiskScoreInput'
type: array
@@ -55162,8 +53529,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality
entity:
@@ -55206,8 +53572,7 @@ components:
name:
type: string
risk:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EntityRiskScoreRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EntityRiskScoreRecord'
type:
items:
type: string
@@ -55292,6 +53657,14 @@ components:
- index
- description
- category
+ Security_Entity_Analytics_API_StoreStatus:
+ enum:
+ - not_installed
+ - installing
+ - running
+ - stopped
+ - error
+ type: string
Security_Entity_Analytics_API_TaskManagerUnavailableResponse:
description: Task manager is unavailable
type: object
@@ -55314,8 +53687,7 @@ components:
type: object
properties:
criticality:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_AssetCriticalityLevel'
required:
- criticality
entity:
@@ -55354,8 +53726,7 @@ components:
name:
type: string
risk:
- $ref: >-
- #/components/schemas/Security_Entity_Analytics_API_EntityRiskScoreRecord
+ $ref: '#/components/schemas/Security_Entity_Analytics_API_EntityRiskScoreRecord'
roles:
items:
type: string
@@ -55375,8 +53746,7 @@ components:
- comment
Security_Exceptions_API_CreateExceptionListItemCommentArray:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateExceptionListItemComment
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateExceptionListItemComment'
type: array
Security_Exceptions_API_CreateRuleExceptionListItemComment:
type: object
@@ -55387,28 +53757,23 @@ components:
- comment
Security_Exceptions_API_CreateRuleExceptionListItemCommentArray:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemComment
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemComment'
type: array
Security_Exceptions_API_CreateRuleExceptionListItemProps:
type: object
properties:
comments:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Exceptions_API_CreateRuleExceptionListItemCommentArray'
default: []
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
meta:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemMeta'
name:
@@ -55417,8 +53782,7 @@ components:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
default: single
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray'
default: []
tags:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemTags'
@@ -55441,8 +53805,7 @@ components:
created_by:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListDescription'
id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListId'
immutable:
@@ -55456,8 +53819,7 @@ components:
namespace_type:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListOsTypeArray'
tags:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListTags'
tie_breaker_id:
@@ -55498,27 +53860,23 @@ components:
_version:
type: string
comments:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemCommentArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemCommentArray'
created_at:
format: date-time
type: string
created_by:
type: string
description:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemDescription
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemDescription'
entries:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryArray'
expire_time:
format: date-time
type: string
id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemId'
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
list_id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
meta:
@@ -55528,8 +53886,7 @@ components:
namespace_type:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionNamespaceType'
os_types:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemOsTypeArray'
tags:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemTags'
tie_breaker_id:
@@ -55586,18 +53943,12 @@ components:
type: string
Security_Exceptions_API_ExceptionListItemEntry:
anyOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatch
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchAny
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryList
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryExists
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryNested
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchWildcard
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatch'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchAny'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryList'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryExists'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryNested'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchWildcard'
discriminator:
propertyName: type
Security_Exceptions_API_ExceptionListItemEntryArray:
@@ -55610,8 +53961,7 @@ components:
field:
$ref: '#/components/schemas/Security_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- exists
@@ -55636,8 +53986,7 @@ components:
- id
- type
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- list
@@ -55653,8 +54002,7 @@ components:
field:
$ref: '#/components/schemas/Security_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- match
@@ -55672,8 +54020,7 @@ components:
field:
$ref: '#/components/schemas/Security_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- match_any
@@ -55694,8 +54041,7 @@ components:
field:
$ref: '#/components/schemas/Security_Exceptions_API_NonEmptyString'
operator:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryOperator'
type:
enum:
- wildcard
@@ -55712,8 +54058,7 @@ components:
properties:
entries:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryNestedEntryItem
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryNestedEntryItem'
minItems: 1
type: array
field:
@@ -55728,12 +54073,9 @@ components:
- entries
Security_Exceptions_API_ExceptionListItemEntryNestedEntryItem:
oneOf:
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatch
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchAny
- - $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemEntryExists
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatch'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryMatchAny'
+ - $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemEntryExists'
Security_Exceptions_API_ExceptionListItemEntryOperator:
enum:
- excluded
@@ -55791,16 +54133,14 @@ components:
id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListId'
item_id:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListItemHumanId'
list_id:
$ref: '#/components/schemas/Security_Exceptions_API_ExceptionListHumanId'
required:
- error
Security_Exceptions_API_ExceptionListsImportBulkErrorArray:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_ExceptionListsImportBulkError
+ $ref: '#/components/schemas/Security_Exceptions_API_ExceptionListsImportBulkError'
type: array
Security_Exceptions_API_ExceptionListTags:
items:
@@ -55820,15 +54160,11 @@ components:
minimum: 1
type: integer
Security_Exceptions_API_ExceptionNamespaceType:
- description: >
- Determines whether the exception container is available in all Kibana
- spaces or just the space
-
+ description: |
+ Determines whether the exception container is available in all Kibana spaces or just the space
in which it is created, where:
-
- `single`: Only available in the Kibana space in which it is created.
-
- `agnostic`: Available in all Kibana spaces.
enum:
- agnostic
@@ -55907,8 +54243,7 @@ components:
- comment
Security_Exceptions_API_UpdateExceptionListItemCommentArray:
items:
- $ref: >-
- #/components/schemas/Security_Exceptions_API_UpdateExceptionListItemComment
+ $ref: '#/components/schemas/Security_Exceptions_API_UpdateExceptionListItemComment'
type: array
Security_Exceptions_API_UUID:
description: A universally unique identifier
@@ -56600,9 +54935,7 @@ components:
$ref: '#/components/schemas/Security_Timeline_API_DataProviderType'
nullable: true
Security_Timeline_API_DataProviderType:
- description: >-
- The type of data provider to create. Valid values are `default` and
- `template`.
+ description: The type of data provider to create. Valid values are `default` and `template`.
enum:
- default
- template
@@ -56796,8 +55129,7 @@ components:
oneOf:
- allOf:
- $ref: '#/components/schemas/Security_Timeline_API_PinnedEvent'
- - $ref: >-
- #/components/schemas/Security_Timeline_API_PinnedEventBaseResponseBody
+ - $ref: '#/components/schemas/Security_Timeline_API_PinnedEventBaseResponseBody'
- nullable: true
type: object
Security_Timeline_API_PersistTimelineResponse:
@@ -56865,15 +55197,13 @@ components:
type: object
properties:
alias_purpose:
- $ref: >-
- #/components/schemas/Security_Timeline_API_SavedObjectResolveAliasPurpose
+ $ref: '#/components/schemas/Security_Timeline_API_SavedObjectResolveAliasPurpose'
alias_target_id:
type: string
outcome:
$ref: '#/components/schemas/Security_Timeline_API_SavedObjectResolveOutcome'
timeline:
- $ref: >-
- #/components/schemas/Security_Timeline_API_TimelineSavedToReturnObject
+ $ref: '#/components/schemas/Security_Timeline_API_TimelineSavedToReturnObject'
required:
- timeline
- outcome
@@ -57018,8 +55348,7 @@ components:
nullable: true
type: string
kqlQuery:
- $ref: >-
- #/components/schemas/Security_Timeline_API_SerializedFilterQueryResult
+ $ref: '#/components/schemas/Security_Timeline_API_SerializedFilterQueryResult'
nullable: true
savedQueryId:
nullable: true
@@ -57116,8 +55445,7 @@ components:
Security_Timeline_API_TimelineResponse:
allOf:
- $ref: '#/components/schemas/Security_Timeline_API_SavedTimeline'
- - $ref: >-
- #/components/schemas/Security_Timeline_API_SavedTimelineWithSavedObjectId
+ - $ref: '#/components/schemas/Security_Timeline_API_SavedTimelineWithSavedObjectId'
- type: object
properties:
eventIdToNoteIds:
@@ -57183,18 +55511,14 @@ components:
- savedObjectId
- version
Security_Timeline_API_TimelineStatus:
- description: >-
- The status of the timeline. Valid values are `active`, `draft`, and
- `immutable`.
+ description: The status of the timeline. Valid values are `active`, `draft`, and `immutable`.
enum:
- active
- draft
- immutable
type: string
Security_Timeline_API_TimelineType:
- description: >-
- The type of timeline to create. Valid values are `default` and
- `template`.
+ description: The type of timeline to create. Valid values are `default` and `template`.
enum:
- default
- template
@@ -57293,9 +55617,8 @@ components:
title: Budgeting method
type: string
SLOs_create_slo_request:
- description: >
- The create SLO API request body varies depending on the type of
- indicator, time window and budgeting method.
+ description: |
+ The create SLO API request body varies depending on the type of indicator, time window and budgeting method.
properties:
budgetingMethod:
$ref: '#/components/schemas/SLOs_budgeting_method'
@@ -57305,9 +55628,7 @@ components:
groupBy:
$ref: '#/components/schemas/SLOs_group_by'
id:
- description: >-
- A optional and unique identifier for the SLO. Must be between 8 and
- 36 chars
+ description: A optional and unique identifier for the SLO. Must be between 8 and 36 chars
example: my-super-slo-id
type: string
indicator:
@@ -57351,10 +55672,8 @@ components:
required:
- id
SLOs_delete_slo_instances_request:
- description: >
- The delete SLO instances request takes a list of SLO id and instance id,
- then delete the rollup and summary data. This API can be used to remove
- the staled data of an instance SLO that no longer get updated.
+ description: |
+ The delete SLO instances request takes a list of SLO id and instance id, then delete the rollup and summary data. This API can be used to remove the staled data of an instance SLO that no longer get updated.
properties:
list:
description: An array of slo id and instance id
@@ -57390,9 +55709,7 @@ components:
example: 0.02
type: number
isEstimated:
- description: >-
- Only for SLO defined with occurrences budgeting method and calendar
- aligned time window.
+ description: Only for SLO defined with occurrences budgeting method and calendar aligned time window.
example: true
type: boolean
remaining:
@@ -57463,9 +55780,7 @@ components:
title: Find SLO response
type: object
SLOs_group_by:
- description: >-
- optional group by field or fields to use to generate an SLO per distinct
- value
+ description: optional group by field or fields to use to generate an SLO per distinct value
example:
- - service.name
- service.name
@@ -57586,11 +55901,7 @@ components:
type: object
properties:
dataViewId:
- description: >-
- The kibana data view id to use, primarily used to include data
- view runtime mappings. Make sure to save SLO again if you
- add/update run time fields to the data view and if those fields
- are being used in slo queries.
+ description: The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
example: 03b80ab3-003d-498b-881c-3beedbaf1162
type: string
filter:
@@ -57631,11 +55942,7 @@ components:
type: object
properties:
dataViewId:
- description: >-
- The kibana data view id to use, primarily used to include data
- view runtime mappings. Make sure to save SLO again if you
- add/update run time fields to the data view and if those fields
- are being used in slo queries.
+ description: The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
example: 03b80ab3-003d-498b-881c-3beedbaf1162
type: string
filter:
@@ -57652,16 +55959,12 @@ components:
example: A
type: string
metrics:
- description: >-
- List of metrics with their name, aggregation type, and
- field.
+ description: List of metrics with their name, aggregation type, and field.
items:
type: object
properties:
aggregation:
- description: >-
- The aggregation type of the metric. Only valid option
- is "sum"
+ description: The aggregation type of the metric. Only valid option is "sum"
enum:
- sum
example: sum
@@ -57706,16 +56009,12 @@ components:
example: A
type: string
metrics:
- description: >-
- List of metrics with their name, aggregation type, and
- field.
+ description: List of metrics with their name, aggregation type, and field.
items:
type: object
properties:
aggregation:
- description: >-
- The aggregation type of the metric. Only valid option
- is "sum"
+ description: The aggregation type of the metric. Only valid option is "sum"
enum:
- sum
example: sum
@@ -57764,11 +56063,7 @@ components:
type: object
properties:
dataViewId:
- description: >-
- The kibana data view id to use, primarily used to include data
- view runtime mappings. Make sure to save SLO again if you
- add/update run time fields to the data view and if those fields
- are being used in slo queries.
+ description: The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
example: 03b80ab3-003d-498b-881c-3beedbaf1162
type: string
filter:
@@ -57796,15 +56091,11 @@ components:
example: 'processor.outcome: "success"'
type: string
from:
- description: >-
- The starting value of the range. Only required for "range"
- aggregations.
+ description: The starting value of the range. Only required for "range" aggregations.
example: 0
type: number
to:
- description: >-
- The ending value of the range. Only required for "range"
- aggregations.
+ description: The ending value of the range. Only required for "range" aggregations.
example: 100
type: number
required:
@@ -57840,15 +56131,11 @@ components:
example: 'processor.outcome : *'
type: string
from:
- description: >-
- The starting value of the range. Only required for "range"
- aggregations.
+ description: The starting value of the range. Only required for "range" aggregations.
example: 0
type: number
to:
- description: >-
- The ending value of the range. Only required for "range"
- aggregations.
+ description: The ending value of the range. Only required for "range" aggregations.
example: 100
type: number
required:
@@ -57877,11 +56164,7 @@ components:
type: object
properties:
dataViewId:
- description: >-
- The kibana data view id to use, primarily used to include data
- view runtime mappings. Make sure to save SLO again if you
- add/update run time fields to the data view and if those fields
- are being used in slo queries.
+ description: The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
example: 03b80ab3-003d-498b-881c-3beedbaf1162
type: string
filter:
@@ -57893,15 +56176,12 @@ components:
example: my-service-*
type: string
metric:
- description: >
- An object defining the metrics, equation, and threshold to
- determine if it's a good slice or not
+ description: |
+ An object defining the metrics, equation, and threshold to determine if it's a good slice or not
type: object
properties:
comparator:
- description: >-
- The comparator to use to compare the equation to the
- threshold.
+ description: The comparator to use to compare the equation to the threshold.
enum:
- GT
- GTE
@@ -57914,22 +56194,15 @@ components:
example: A
type: string
metrics:
- description: >-
- List of metrics with their name, aggregation type, and
- field.
+ description: List of metrics with their name, aggregation type, and field.
items:
anyOf:
- - $ref: >-
- #/components/schemas/SLOs_timeslice_metric_basic_metric_with_field
- - $ref: >-
- #/components/schemas/SLOs_timeslice_metric_percentile_metric
- - $ref: >-
- #/components/schemas/SLOs_timeslice_metric_doc_count_metric
+ - $ref: '#/components/schemas/SLOs_timeslice_metric_basic_metric_with_field'
+ - $ref: '#/components/schemas/SLOs_timeslice_metric_percentile_metric'
+ - $ref: '#/components/schemas/SLOs_timeslice_metric_doc_count_metric'
type: array
threshold:
- description: >-
- The threshold used to determine if the metric is a good
- slice or not.
+ description: The threshold used to determine if the metric is a good slice or not.
example: 100
type: number
required:
@@ -58012,17 +56285,13 @@ components:
minimum: 0
type: number
timesliceTarget:
- description: >-
- the target objective for each slice when using a timeslices
- budgeting method
+ description: the target objective for each slice when using a timeslices budgeting method
example: 0.995
maximum: 100
minimum: 0
type: number
timesliceWindow:
- description: >-
- the duration of each slice when using a timeslices budgeting method,
- as {duraton}{unit}
+ description: the duration of each slice when using a timeslices budgeting method, as {duraton}{unit}
example: 5m
type: string
required:
@@ -58254,16 +56523,11 @@ components:
type: object
properties:
duration:
- description: >-
- the duration formatted as {duration}{unit}. Accepted values for
- rolling: 7d, 30d, 90d. Accepted values for calendar aligned: 1w
- (weekly) or 1M (monthly)
+ description: 'the duration formatted as {duration}{unit}. Accepted values for rolling: 7d, 30d, 90d. Accepted values for calendar aligned: 1w (weekly) or 1M (monthly)'
example: 30d
type: string
type:
- description: >-
- Indicates weither the time window is a rolling or a calendar aligned
- time window.
+ description: Indicates weither the time window is a rolling or a calendar aligned time window.
enum:
- rolling
- calendarAligned
@@ -58332,9 +56596,7 @@ components:
type: object
properties:
aggregation:
- description: >-
- The aggregation type of the metric. Only valid option is
- "percentile"
+ description: The aggregation type of the metric. Only valid option is "percentile"
enum:
- percentile
example: percentile
@@ -58363,9 +56625,8 @@ components:
- percentile
title: Timeslice Metric Percentile Metric
SLOs_update_slo_request:
- description: >
- The update SLO API request body varies depending on the type of
- indicator, time window and budgeting method. Partial update is handled.
+ description: |
+ The update SLO API request body varies depending on the type of indicator, time window and budgeting method. Partial update is handled.
properties:
budgetingMethod:
$ref: '#/components/schemas/SLOs_budgeting_method'
@@ -58398,128 +56659,2866 @@ components:
$ref: '#/components/schemas/SLOs_time_window'
title: Update SLO request
type: object
- securitySchemes:
- apiKeyAuth:
- description: >
- These APIs use key-based authentication. You must create an API key and
- use the encoded value in the request header. For example:
- `Authorization: ApiKey base64AccessApiKey`
- in: header
- name: Authorization
- type: apiKey
- basicAuth:
- scheme: basic
- type: http
-security:
- - apiKeyAuth: []
- - basicAuth: []
-tags:
- - name: alerting
- - description: |
- Adjust APM agent configuration without need to redeploy your application.
- name: APM agent configuration
- - description: >
- Configure APM agent keys to authorize requests from APM agents to the APM
- Server.
- name: APM agent keys
- - description: >
- Annotate visualizations in the APM app with significant events.
- Annotations enable you to easily see how events are impacting the
- performance of your applications.
- name: APM annotations
- - description: Create APM fleet server schema.
- name: APM server schema
- - description: Configure APM source maps.
- name: APM sourcemaps
- - description: Case APIs enable you to open and track issues.
- name: cases
- - name: connectors
- - name: Data streams
- - description: >-
- Data view APIs enable you to manage data views, formerly known as Kibana
- index patterns.
- name: data views
- - name: Elastic Agent actions
- - name: Elastic Agent binary download sources
- - name: Elastic Agent policies
- - name: Elastic Agent status
- - name: Elastic Agents
- - name: Elastic Package Manager (EPM)
- - name: Fleet enrollment API keys
- - name: Fleet internals
- - name: Fleet outputs
- - name: Fleet package policies
- - name: Fleet proxies
- - name: Fleet Server hosts
- - name: Fleet service tokens
- - name: Fleet uninstall tokens
- - name: Message Signing Service
- - description: Machine learning
- name: ml
- - name: roles
- - description: >
- Export sets of saved objects that you want to import into Kibana, resolve
- import errors, and rotate an encryption key for encrypted saved objects
- with the saved objects APIs.
-
-
- To manage a specific type of saved object, use the corresponding APIs.
-
- For example, use:
-
-
- * [Data views](../group/endpoint-data-views)
-
- * [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)
-
- * [Short
- URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)
-
-
- Warning: Do not write documents directly to the `.kibana` index. When you
- write directly to the `.kibana` index, the data becomes corrupted and
- permanently breaks future Kibana versions.
- name: saved objects
- x-displayName: Saved objects
- - description: Manage and interact with Security Assistant resources.
- name: Security AI Assistant API
- x-displayName: Security AI assistant
- - description: >-
- You can create rules that automatically turn events and external alerts
- sent to Elastic Security into detection alerts. These alerts are displayed
- on the Detections page.
- name: Security Detections API
- x-displayName: Security detections
- - description: >-
- Endpoint Exceptions API allows you to manage detection rule endpoint
- exceptions to prevent a rule from generating an alert from incoming events
- even when the rule's other criteria are met.
- name: Security Endpoint Exceptions API
- x-displayName: Security endpoint exceptions
- - description: Interact with and manage endpoints running the Elastic Defend integration.
- name: Security Endpoint Management API
- x-displayName: Security endpoint management
- - description: ''
- name: Security Entity Analytics API
- x-displayName: Security entity analytics
- - description: >-
- Exceptions API allows you to manage detection rule exceptions to prevent a
- rule from generating an alert from incoming events even when the rule's
- other criteria are met.
- name: Security Exceptions API
- x-displayName: Security exceptions
- - description: Lists API allows you to manage lists of keywords, IPs or IP ranges items.
- name: Security Lists API
- x-displayName: Security lists
- - description: Run live queries, manage packs and saved queries.
- name: Security Osquery API
- x-displayName: Security Osquery
- - description: >-
- You can create Timelines and Timeline templates via the API, as well as
- import new Timelines from an ndjson file.
- name: Security Timeline API
- x-displayName: Security timeline
- - description: SLO APIs enable you to define, manage and track service-level objectives
- name: slo
- - name: spaces
- - name: system
+ bedrock_config:
+ title: Connector request properties for an Amazon Bedrock connector
+ description: Defines properties for connectors when type is `.bedrock`.
+ type: object
+ required:
+ - apiUrl
+ properties:
+ apiUrl:
+ type: string
+ description: The Amazon Bedrock request URL.
+ defaultModel:
+ type: string
+ description: |
+ The generative artificial intelligence model for Amazon Bedrock to use. Current support is for the Anthropic Claude models.
+ default: anthropic.claude-3-5-sonnet-20240620-v1:0
+ crowdstrike_config:
+ title: Connector request config properties for a Crowdstrike connector
+ required:
+ - url
+ description: Defines config properties for connectors when type is `.crowdstrike`.
+ type: object
+ properties:
+ url:
+ description: |
+ The CrowdStrike tenant URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ type: string
+ d3security_config:
+ title: Connector request properties for a D3 Security connector
+ description: Defines properties for connectors when type is `.d3security`.
+ type: object
+ required:
+ - url
+ properties:
+ url:
+ type: string
+ description: |
+ The D3 Security API request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ email_config:
+ title: Connector request properties for an email connector
+ description: Defines properties for connectors when type is `.email`.
+ required:
+ - from
+ type: object
+ properties:
+ clientId:
+ description: |
+ The client identifier, which is a part of OAuth 2.0 client credentials authentication, in GUID format. If `service` is `exchange_server`, this property is required.
+ type: string
+ nullable: true
+ from:
+ description: |
+ The from address for all emails sent by the connector. It must be specified in `user@host-name` format.
+ type: string
+ hasAuth:
+ description: |
+ Specifies whether a user and password are required inside the secrets configuration.
+ default: true
+ type: boolean
+ host:
+ description: |
+ The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.
+ type: string
+ oauthTokenUrl:
+ type: string
+ nullable: true
+ port:
+ description: |
+ The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.
+ type: integer
+ secure:
+ description: |
+ Specifies whether the connection to the service provider will use TLS. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored.
+ type: boolean
+ service:
+ description: |
+ The name of the email service.
+ type: string
+ enum:
+ - elastic_cloud
+ - exchange_server
+ - gmail
+ - other
+ - outlook365
+ - ses
+ tenantId:
+ description: |
+ The tenant identifier, which is part of OAuth 2.0 client credentials authentication, in GUID format. If `service` is `exchange_server`, this property is required.
+ type: string
+ nullable: true
+ gemini_config:
+ title: Connector request properties for an Google Gemini connector
+ description: Defines properties for connectors when type is `.gemini`.
+ type: object
+ required:
+ - apiUrl
+ - gcpRegion
+ - gcpProjectID
+ properties:
+ apiUrl:
+ type: string
+ description: The Google Gemini request URL.
+ defaultModel:
+ type: string
+ description: The generative artificial intelligence model for Google Gemini to use.
+ default: gemini-1.5-pro-002
+ gcpRegion:
+ type: string
+ description: The GCP region where the Vertex AI endpoint enabled.
+ gcpProjectID:
+ type: string
+ description: The Google ProjectID that has Vertex AI endpoint enabled.
+ resilient_config:
+ title: Connector request properties for a IBM Resilient connector
+ required:
+ - apiUrl
+ - orgId
+ description: Defines properties for connectors when type is `.resilient`.
+ type: object
+ properties:
+ apiUrl:
+ description: The IBM Resilient instance URL.
+ type: string
+ orgId:
+ description: The IBM Resilient organization ID.
+ type: string
+ index_config:
+ title: Connector request properties for an index connector
+ required:
+ - index
+ description: Defines properties for connectors when type is `.index`.
+ type: object
+ properties:
+ executionTimeField:
+ description: A field that indicates when the document was indexed.
+ default: null
+ type: string
+ nullable: true
+ index:
+ description: The Elasticsearch index to be written to.
+ type: string
+ refresh:
+ description: |
+ The refresh policy for the write request, which affects when changes are made visible to search. Refer to the refresh setting for Elasticsearch document APIs.
+ default: false
+ type: boolean
+ jira_config:
+ title: Connector request properties for a Jira connector
+ required:
+ - apiUrl
+ - projectKey
+ description: Defines properties for connectors when type is `.jira`.
+ type: object
+ properties:
+ apiUrl:
+ description: The Jira instance URL.
+ type: string
+ projectKey:
+ description: The Jira project key.
+ type: string
+ genai_azure_config:
+ title: Connector request properties for an OpenAI connector that uses Azure OpenAI
+ description: |
+ Defines properties for connectors when type is `.gen-ai` and the API provider is `Azure OpenAI`.
+ type: object
+ required:
+ - apiProvider
+ - apiUrl
+ properties:
+ apiProvider:
+ type: string
+ description: The OpenAI API provider.
+ enum:
+ - Azure OpenAI
+ apiUrl:
+ type: string
+ description: The OpenAI API endpoint.
+ genai_openai_config:
+ title: Connector request properties for an OpenAI connector
+ description: |
+ Defines properties for connectors when type is `.gen-ai` and the API provider is `OpenAI`.
+ type: object
+ required:
+ - apiProvider
+ - apiUrl
+ properties:
+ apiProvider:
+ type: string
+ description: The OpenAI API provider.
+ enum:
+ - OpenAI
+ apiUrl:
+ type: string
+ description: The OpenAI API endpoint.
+ defaultModel:
+ type: string
+ description: The default model to use for requests.
+ opsgenie_config:
+ title: Connector request properties for an Opsgenie connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.opsgenie`.
+ type: object
+ properties:
+ apiUrl:
+ description: |
+ The Opsgenie URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ type: string
+ pagerduty_config:
+ title: Connector request properties for a PagerDuty connector
+ description: Defines properties for connectors when type is `.pagerduty`.
+ type: object
+ properties:
+ apiUrl:
+ description: The PagerDuty event URL.
+ type: string
+ nullable: true
+ example: https://events.pagerduty.com/v2/enqueue
+ sentinelone_config:
+ title: Connector request properties for a SentinelOne connector
+ required:
+ - url
+ description: Defines properties for connectors when type is `.sentinelone`.
+ type: object
+ properties:
+ url:
+ description: |
+ The SentinelOne tenant URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ type: string
+ servicenow_config:
+ title: Connector request properties for a ServiceNow ITSM connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.servicenow`.
+ type: object
+ properties:
+ apiUrl:
+ type: string
+ description: The ServiceNow instance URL.
+ clientId:
+ description: |
+ The client ID assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ isOAuth:
+ description: |
+ The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).
+ default: false
+ type: boolean
+ jwtKeyId:
+ description: |
+ The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ userIdentifierValue:
+ description: |
+ The identifier to use for OAuth authentication. This identifier should be the user field you selected when you created an OAuth JWT API endpoint for external clients in your ServiceNow instance. For example, if the selected user field is `Email`, the user identifier should be the user's email address. This property is required when `isOAuth` is `true`.
+ type: string
+ usesTableApi:
+ description: |
+ Determines whether the connector uses the Table API or the Import Set API. This property is supported only for ServiceNow ITSM and ServiceNow SecOps connectors. NOTE: If this property is set to `false`, the Elastic application should be installed in ServiceNow.
+ default: true
+ type: boolean
+ servicenow_itom_config:
+ title: Connector request properties for a ServiceNow ITOM connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.servicenow-itom`.
+ type: object
+ properties:
+ apiUrl:
+ type: string
+ description: The ServiceNow instance URL.
+ clientId:
+ description: |
+ The client ID assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ isOAuth:
+ description: |
+ The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).
+ default: false
+ type: boolean
+ jwtKeyId:
+ description: |
+ The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ userIdentifierValue:
+ description: |
+ The identifier to use for OAuth authentication. This identifier should be the user field you selected when you created an OAuth JWT API endpoint for external clients in your ServiceNow instance. For example, if the selected user field is `Email`, the user identifier should be the user's email address. This property is required when `isOAuth` is `true`.
+ type: string
+ slack_api_config:
+ title: Connector request properties for a Slack connector
+ description: Defines properties for connectors when type is `.slack_api`.
+ type: object
+ properties:
+ allowedChannels:
+ type: array
+ description: A list of valid Slack channels.
+ items:
+ type: object
+ required:
+ - id
+ - name
+ maxItems: 25
+ properties:
+ id:
+ type: string
+ description: The Slack channel ID.
+ example: C123ABC456
+ minLength: 1
+ name:
+ type: string
+ description: The Slack channel name.
+ minLength: 1
+ swimlane_config:
+ title: Connector request properties for a Swimlane connector
+ required:
+ - apiUrl
+ - appId
+ - connectorType
+ description: Defines properties for connectors when type is `.swimlane`.
+ type: object
+ properties:
+ apiUrl:
+ description: The Swimlane instance URL.
+ type: string
+ appId:
+ description: The Swimlane application ID.
+ type: string
+ connectorType:
+ description: The type of connector. Valid values are `all`, `alerts`, and `cases`.
+ type: string
+ enum:
+ - all
+ - alerts
+ - cases
+ mappings:
+ title: Connector mappings properties for a Swimlane connector
+ description: The field mapping.
+ type: object
+ properties:
+ alertIdConfig:
+ title: Alert identifier mapping
+ description: Mapping for the alert ID.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ caseIdConfig:
+ title: Case identifier mapping
+ description: Mapping for the case ID.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ caseNameConfig:
+ title: Case name mapping
+ description: Mapping for the case name.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ commentsConfig:
+ title: Case comment mapping
+ description: Mapping for the case comments.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ descriptionConfig:
+ title: Case description mapping
+ description: Mapping for the case description.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ ruleNameConfig:
+ title: Rule name mapping
+ description: Mapping for the name of the alert's rule.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ severityConfig:
+ title: Severity mapping
+ description: Mapping for the severity.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ thehive_config:
+ title: Connector request properties for a TheHive connector
+ description: Defines configuration properties for connectors when type is `.thehive`.
+ type: object
+ required:
+ - url
+ properties:
+ organisation:
+ type: string
+ description: |
+ The organisation in TheHive that will contain the alerts or cases. By default, the connector uses the default organisation of the user account that created the API key.
+ url:
+ type: string
+ description: |
+ The instance URL in TheHive. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ tines_config:
+ title: Connector request properties for a Tines connector
+ description: Defines properties for connectors when type is `.tines`.
+ type: object
+ required:
+ - url
+ properties:
+ url:
+ description: |
+ The Tines tenant URL. If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.
+ type: string
+ torq_config:
+ title: Connector request properties for a Torq connector
+ description: Defines properties for connectors when type is `.torq`.
+ type: object
+ required:
+ - webhookIntegrationUrl
+ properties:
+ webhookIntegrationUrl:
+ description: The endpoint URL of the Elastic Security integration in Torq.
+ type: string
+ auth_type:
+ title: Authentication type
+ type: string
+ nullable: true
+ enum:
+ - webhook-authentication-basic
+ - webhook-authentication-ssl
+ description: |
+ The type of authentication to use: basic, SSL, or none.
+ ca:
+ title: Certificate authority
+ type: string
+ description: |
+ A base64 encoded version of the certificate authority file that the connector can trust to sign and validate certificates. This option is available for all authentication types.
+ cert_type:
+ title: Certificate type
+ type: string
+ description: |
+ If the `authType` is `webhook-authentication-ssl`, specifies whether the certificate authentication data is in a CRT and key file format or a PFX file format.
+ enum:
+ - ssl-crt-key
+ - ssl-pfx
+ has_auth:
+ title: Has authentication
+ type: boolean
+ description: If true, a username and password for login type authentication must be provided.
+ default: true
+ verification_mode:
+ title: Verification mode
+ type: string
+ enum:
+ - certificate
+ - full
+ - none
+ default: full
+ description: |
+ Controls the verification of certificates. Use `full` to validate that the certificate has an issue date within the `not_before` and `not_after` dates, chains to a trusted certificate authority (CA), and has a hostname or IP address that matches the names within the certificate. Use `certificate` to validate the certificate and verify that it is signed by a trusted authority; this option does not check the certificate hostname. Use `none` to skip certificate validation.
+ webhook_config:
+ title: Connector request properties for a Webhook connector
+ description: Defines properties for connectors when type is `.webhook`.
+ type: object
+ properties:
+ authType:
+ $ref: '#/components/schemas/auth_type'
+ ca:
+ $ref: '#/components/schemas/ca'
+ certType:
+ $ref: '#/components/schemas/cert_type'
+ hasAuth:
+ $ref: '#/components/schemas/has_auth'
+ headers:
+ type: object
+ nullable: true
+ description: A set of key-value pairs sent as headers with the request.
+ method:
+ type: string
+ default: post
+ enum:
+ - post
+ - put
+ description: |
+ The HTTP request method, either `post` or `put`.
+ url:
+ type: string
+ description: |
+ The request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ verificationMode:
+ $ref: '#/components/schemas/verification_mode'
+ cases_webhook_config:
+ title: Connector request properties for Webhook - Case Management connector
+ required:
+ - createIncidentJson
+ - createIncidentResponseKey
+ - createIncidentUrl
+ - getIncidentResponseExternalTitleKey
+ - getIncidentUrl
+ - updateIncidentJson
+ - updateIncidentUrl
+ - viewIncidentUrl
+ description: Defines properties for connectors when type is `.cases-webhook`.
+ type: object
+ properties:
+ authType:
+ $ref: '#/components/schemas/auth_type'
+ ca:
+ $ref: '#/components/schemas/ca'
+ certType:
+ $ref: '#/components/schemas/cert_type'
+ createCommentJson:
+ type: string
+ description: |
+ A JSON payload sent to the create comment URL to create a case comment. You can use variables to add Kibana Cases data to the payload. The required variable is `case.comment`. Due to Mustache template variables (the text enclosed in triple braces, for example, `{{{case.title}}}`), the JSON is not validated when you create the connector. The JSON is validated once the Mustache variables have been placed when the REST method runs. Manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass.
+ example: '{"body": {{{case.comment}}}}'
+ createCommentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to create a case comment in the third-party system. Valid values are `patch`, `post`, and `put`.
+ default: put
+ enum:
+ - patch
+ - post
+ - put
+ createCommentUrl:
+ type: string
+ description: |
+ The REST API URL to create a case comment by ID in the third-party system. You can use a variable to add the external system ID to the URL. If you are using the `xpack.actions.allowedHosts setting`, add the hostname to the allowed hosts.
+ example: https://example.com/issue/{{{external.system.id}}}/comment
+ createIncidentJson:
+ type: string
+ description: |
+ A JSON payload sent to the create case URL to create a case. You can use variables to add case data to the payload. Required variables are `case.title` and `case.description`. Due to Mustache template variables (which is the text enclosed in triple braces, for example, `{{{case.title}}}`), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid to avoid future validation errors; disregard Mustache variables during your review.
+ example: '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
+ createIncidentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to create a case in the third-party system. Valid values are `patch`, `post`, and `put`.
+ enum:
+ - patch
+ - post
+ - put
+ default: post
+ createIncidentResponseKey:
+ type: string
+ description: The JSON key in the create external case response that contains the case ID.
+ createIncidentUrl:
+ type: string
+ description: |
+ The REST API URL to create a case in the third-party system. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ getIncidentResponseExternalTitleKey:
+ type: string
+ description: The JSON key in get external case response that contains the case title.
+ getIncidentUrl:
+ type: string
+ description: |
+ The REST API URL to get the case by ID from the third-party system. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts. You can use a variable to add the external system ID to the URL. Due to Mustache template variables (the text enclosed in triple braces, for example, `{{{case.title}}}`), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass.
+ example: https://example.com/issue/{{{external.system.id}}}
+ hasAuth:
+ $ref: '#/components/schemas/has_auth'
+ headers:
+ type: string
+ description: |
+ A set of key-value pairs sent as headers with the request URLs for the create case, update case, get case, and create comment methods.
+ updateIncidentJson:
+ type: string
+ description: |
+ The JSON payload sent to the update case URL to update the case. You can use variables to add Kibana Cases data to the payload. Required variables are `case.title` and `case.description`. Due to Mustache template variables (which is the text enclosed in triple braces, for example, `{{{case.title}}}`), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid to avoid future validation errors; disregard Mustache variables during your review.
+ example: '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
+ updateIncidentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to update the case in the third-party system. Valid values are `patch`, `post`, and `put`.
+ default: put
+ enum:
+ - patch
+ - post
+ - put
+ updateIncidentUrl:
+ type: string
+ description: |
+ The REST API URL to update the case by ID in the third-party system. You can use a variable to add the external system ID to the URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ example: https://example.com/issue/{{{external.system.ID}}}
+ verificationMode:
+ $ref: '#/components/schemas/verification_mode'
+ viewIncidentUrl:
+ type: string
+ description: |
+ The URL to view the case in the external system. You can use variables to add the external system ID or external system title to the URL.
+ example: https://testing-jira.atlassian.net/browse/{{{external.system.title}}}
+ xmatters_config:
+ title: Connector request properties for an xMatters connector
+ description: Defines properties for connectors when type is `.xmatters`.
+ type: object
+ properties:
+ configUrl:
+ description: |
+ The request URL for the Elastic Alerts trigger in xMatters. It is applicable only when `usesBasic` is `true`.
+ type: string
+ nullable: true
+ usesBasic:
+ description: Specifies whether the connector uses HTTP basic authentication (`true`) or URL authentication (`false`).
+ type: boolean
+ default: true
+ bedrock_secrets:
+ title: Connector secrets properties for an Amazon Bedrock connector
+ description: Defines secrets for connectors when type is `.bedrock`.
+ type: object
+ required:
+ - accessKey
+ - secret
+ properties:
+ accessKey:
+ type: string
+ description: The AWS access key for authentication.
+ secret:
+ type: string
+ description: The AWS secret for authentication.
+ crowdstrike_secrets:
+ title: Connector secrets properties for a Crowdstrike connector
+ description: Defines secrets for connectors when type is `.crowdstrike`.
+ type: object
+ required:
+ - clientId
+ - clientSecret
+ properties:
+ clientId:
+ description: The CrowdStrike API client identifier.
+ type: string
+ clientSecret:
+ description: The CrowdStrike API client secret to authenticate the `clientId`.
+ type: string
+ d3security_secrets:
+ title: Connector secrets properties for a D3 Security connector
+ description: Defines secrets for connectors when type is `.d3security`.
+ required:
+ - token
+ type: object
+ properties:
+ token:
+ type: string
+ description: The D3 Security token.
+ email_secrets:
+ title: Connector secrets properties for an email connector
+ description: Defines secrets for connectors when type is `.email`.
+ type: object
+ properties:
+ clientSecret:
+ type: string
+ description: |
+ The Microsoft Exchange Client secret for OAuth 2.0 client credentials authentication. It must be URL-encoded. If `service` is `exchange_server`, this property is required.
+ password:
+ type: string
+ description: |
+ The password for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
+ user:
+ type: string
+ description: |
+ The username for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
+ gemini_secrets:
+ title: Connector secrets properties for a Google Gemini connector
+ description: Defines secrets for connectors when type is `.gemini`.
+ type: object
+ required:
+ - credentialsJson
+ properties:
+ credentialsJson:
+ type: string
+ description: The service account credentials JSON file. The service account should have Vertex AI user IAM role assigned to it.
+ resilient_secrets:
+ title: Connector secrets properties for IBM Resilient connector
+ required:
+ - apiKeyId
+ - apiKeySecret
+ description: Defines secrets for connectors when type is `.resilient`.
+ type: object
+ properties:
+ apiKeyId:
+ type: string
+ description: The authentication key ID for HTTP Basic authentication.
+ apiKeySecret:
+ type: string
+ description: The authentication key secret for HTTP Basic authentication.
+ jira_secrets:
+ title: Connector secrets properties for a Jira connector
+ required:
+ - apiToken
+ - email
+ description: Defines secrets for connectors when type is `.jira`.
+ type: object
+ properties:
+ apiToken:
+ description: The Jira API authentication token for HTTP basic authentication.
+ type: string
+ email:
+ description: The account email for HTTP Basic authentication.
+ type: string
+ teams_secrets:
+ title: Connector secrets properties for a Microsoft Teams connector
+ description: Defines secrets for connectors when type is `.teams`.
+ type: object
+ required:
+ - webhookUrl
+ properties:
+ webhookUrl:
+ type: string
+ description: |
+ The URL of the incoming webhook. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ genai_secrets:
+ title: Connector secrets properties for an OpenAI connector
+ description: Defines secrets for connectors when type is `.gen-ai`.
+ type: object
+ properties:
+ apiKey:
+ type: string
+ description: The OpenAI API key.
+ opsgenie_secrets:
+ title: Connector secrets properties for an Opsgenie connector
+ required:
+ - apiKey
+ description: Defines secrets for connectors when type is `.opsgenie`.
+ type: object
+ properties:
+ apiKey:
+ description: The Opsgenie API authentication key for HTTP Basic authentication.
+ type: string
+ pagerduty_secrets:
+ title: Connector secrets properties for a PagerDuty connector
+ description: Defines secrets for connectors when type is `.pagerduty`.
+ type: object
+ required:
+ - routingKey
+ properties:
+ routingKey:
+ description: |
+ A 32 character PagerDuty Integration Key for an integration on a service.
+ type: string
+ sentinelone_secrets:
+ title: Connector secrets properties for a SentinelOne connector
+ description: Defines secrets for connectors when type is `.sentinelone`.
+ type: object
+ required:
+ - token
+ properties:
+ token:
+ description: The A SentinelOne API token.
+ type: string
+ servicenow_secrets:
+ title: Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors
+ description: Defines secrets for connectors when type is `.servicenow`, `.servicenow-sir`, or `.servicenow-itom`.
+ type: object
+ properties:
+ clientSecret:
+ type: string
+ description: The client secret assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ password:
+ type: string
+ description: The password for HTTP basic authentication. This property is required when `isOAuth` is `false`.
+ privateKey:
+ type: string
+ description: The RSA private key that you created for use in ServiceNow. This property is required when `isOAuth` is `true`.
+ privateKeyPassword:
+ type: string
+ description: The password for the RSA private key. This property is required when `isOAuth` is `true` and you set a password on your private key.
+ username:
+ type: string
+ description: The username for HTTP basic authentication. This property is required when `isOAuth` is `false`.
+ slack_api_secrets:
+ title: Connector secrets properties for a Web API Slack connector
+ description: Defines secrets for connectors when type is `.slack`.
+ required:
+ - token
+ type: object
+ properties:
+ token:
+ type: string
+ description: Slack bot user OAuth token.
+ swimlane_secrets:
+ title: Connector secrets properties for a Swimlane connector
+ description: Defines secrets for connectors when type is `.swimlane`.
+ type: object
+ properties:
+ apiToken:
+ description: Swimlane API authentication token.
+ type: string
+ thehive_secrets:
+ title: Connector secrets properties for a TheHive connector
+ description: Defines secrets for connectors when type is `.thehive`.
+ required:
+ - apiKey
+ type: object
+ properties:
+ apiKey:
+ type: string
+ description: The API key for authentication in TheHive.
+ tines_secrets:
+ title: Connector secrets properties for a Tines connector
+ description: Defines secrets for connectors when type is `.tines`.
+ type: object
+ required:
+ - email
+ - token
+ properties:
+ email:
+ description: The email used to sign in to Tines.
+ type: string
+ token:
+ description: The Tines API token.
+ type: string
+ torq_secrets:
+ title: Connector secrets properties for a Torq connector
+ description: Defines secrets for connectors when type is `.torq`.
+ type: object
+ required:
+ - token
+ properties:
+ token:
+ description: The secret of the webhook authentication header.
+ type: string
+ crt:
+ title: Certificate
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-crt-key`, it is a base64 encoded version of the CRT or CERT file.
+ key:
+ title: Certificate key
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-crt-key`, it is a base64 encoded version of the KEY file.
+ pfx:
+ title: Personal information exchange
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-pfx`, it is a base64 encoded version of the PFX or P12 file.
+ webhook_secrets:
+ title: Connector secrets properties for a Webhook connector
+ description: Defines secrets for connectors when type is `.webhook`.
+ type: object
+ properties:
+ crt:
+ $ref: '#/components/schemas/crt'
+ key:
+ $ref: '#/components/schemas/key'
+ pfx:
+ $ref: '#/components/schemas/pfx'
+ password:
+ type: string
+ description: |
+ The password for HTTP basic authentication or the passphrase for the SSL certificate files. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.
+ user:
+ type: string
+ description: |
+ The username for HTTP basic authentication. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.
+ cases_webhook_secrets:
+ title: Connector secrets properties for Webhook - Case Management connector
+ type: object
+ properties:
+ crt:
+ $ref: '#/components/schemas/crt'
+ key:
+ $ref: '#/components/schemas/key'
+ pfx:
+ $ref: '#/components/schemas/pfx'
+ password:
+ type: string
+ description: |
+ The password for HTTP basic authentication. If `hasAuth` is set to `true` and and `authType` is `webhook-authentication-basic`, this property is required.
+ user:
+ type: string
+ description: |
+ The username for HTTP basic authentication. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.
+ xmatters_secrets:
+ title: Connector secrets properties for an xMatters connector
+ description: Defines secrets for connectors when type is `.xmatters`.
+ type: object
+ properties:
+ password:
+ description: |
+ A user name for HTTP basic authentication. It is applicable only when `usesBasic` is `true`.
+ type: string
+ secretsUrl:
+ description: |
+ The request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL. It is applicable only when `usesBasic` is `false`.
+ type: string
+ user:
+ description: |
+ A password for HTTP basic authentication. It is applicable only when `usesBasic` is `true`.
+ type: string
+ run_acknowledge_resolve_pagerduty:
+ title: PagerDuty connector parameters
+ description: Test an action that acknowledges or resolves a PagerDuty alert.
+ type: object
+ required:
+ - dedupKey
+ - eventAction
+ properties:
+ dedupKey:
+ description: The deduplication key for the PagerDuty alert.
+ type: string
+ maxLength: 255
+ eventAction:
+ description: The type of event.
+ type: string
+ enum:
+ - acknowledge
+ - resolve
+ run_documents:
+ title: Index connector parameters
+ description: Test an action that indexes a document into Elasticsearch.
+ type: object
+ required:
+ - documents
+ properties:
+ documents:
+ type: array
+ description: The documents in JSON format for index connectors.
+ items:
+ type: object
+ additionalProperties: true
+ run_message_email:
+ title: Email connector parameters
+ description: |
+ Test an action that sends an email message. There must be at least one recipient in `to`, `cc`, or `bcc`.
+ type: object
+ required:
+ - message
+ - subject
+ - anyOf:
+ - to
+ - cc
+ - bcc
+ properties:
+ bcc:
+ type: array
+ items:
+ type: string
+ description: |
+ A list of "blind carbon copy" email addresses. Addresses can be specified in `user@host-name` format or in name `` format
+ cc:
+ type: array
+ items:
+ type: string
+ description: |
+ A list of "carbon copy" email addresses. Addresses can be specified in `user@host-name` format or in name `` format
+ message:
+ type: string
+ description: The email message text. Markdown format is supported.
+ subject:
+ type: string
+ description: The subject line of the email.
+ to:
+ type: array
+ description: |
+ A list of email addresses. Addresses can be specified in `user@host-name` format or in name `` format.
+ items:
+ type: string
+ run_message_serverlog:
+ title: Server log connector parameters
+ description: Test an action that writes an entry to the Kibana server log.
+ type: object
+ required:
+ - message
+ properties:
+ level:
+ type: string
+ description: The log level of the message for server log connectors.
+ enum:
+ - debug
+ - error
+ - fatal
+ - info
+ - trace
+ - warn
+ default: info
+ message:
+ type: string
+ description: The message for server log connectors.
+ run_message_slack:
+ title: Slack connector parameters
+ description: |
+ Test an action that sends a message to Slack. It is applicable only when the connector type is `.slack`.
+ type: object
+ required:
+ - message
+ properties:
+ message:
+ type: string
+ description: The Slack message text, which cannot contain Markdown, images, or other advanced formatting.
+ run_trigger_pagerduty:
+ title: PagerDuty connector parameters
+ description: Test an action that triggers a PagerDuty alert.
+ type: object
+ required:
+ - eventAction
+ properties:
+ class:
+ description: The class or type of the event.
+ type: string
+ example: cpu load
+ component:
+ description: The component of the source machine that is responsible for the event.
+ type: string
+ example: eth0
+ customDetails:
+ description: Additional details to add to the event.
+ type: object
+ dedupKey:
+ description: |
+ All actions sharing this key will be associated with the same PagerDuty alert. This value is used to correlate trigger and resolution.
+ type: string
+ maxLength: 255
+ eventAction:
+ description: The type of event.
+ type: string
+ enum:
+ - trigger
+ group:
+ description: The logical grouping of components of a service.
+ type: string
+ example: app-stack
+ links:
+ description: A list of links to add to the event.
+ type: array
+ items:
+ type: object
+ properties:
+ href:
+ description: The URL for the link.
+ type: string
+ text:
+ description: A plain text description of the purpose of the link.
+ type: string
+ severity:
+ description: The severity of the event on the affected system.
+ type: string
+ enum:
+ - critical
+ - error
+ - info
+ - warning
+ default: info
+ source:
+ description: |
+ The affected system, such as a hostname or fully qualified domain name. Defaults to the Kibana saved object id of the action.
+ type: string
+ summary:
+ description: A summery of the event.
+ type: string
+ maxLength: 1024
+ timestamp:
+ description: An ISO-8601 timestamp that indicates when the event was detected or generated.
+ type: string
+ format: date-time
+ run_addevent:
+ title: The addEvent subaction
+ type: object
+ required:
+ - subAction
+ description: The `addEvent` subaction for ServiceNow ITOM connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - addEvent
+ subActionParams:
+ type: object
+ description: The set of configuration properties for the action.
+ properties:
+ additional_info:
+ type: string
+ description: Additional information about the event.
+ description:
+ type: string
+ description: The details about the event.
+ event_class:
+ type: string
+ description: A specific instance of the source.
+ message_key:
+ type: string
+ description: All actions sharing this key are associated with the same ServiceNow alert. The default value is `:`.
+ metric_name:
+ type: string
+ description: The name of the metric.
+ node:
+ type: string
+ description: The host that the event was triggered for.
+ resource:
+ type: string
+ description: The name of the resource.
+ severity:
+ type: string
+ description: The severity of the event.
+ source:
+ type: string
+ description: The name of the event source type.
+ time_of_event:
+ type: string
+ description: The time of the event.
+ type:
+ type: string
+ description: The type of event.
+ run_closealert:
+ title: The closeAlert subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `closeAlert` subaction for Opsgenie connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - closeAlert
+ subActionParams:
+ type: object
+ required:
+ - alias
+ properties:
+ alias:
+ type: string
+ description: The unique identifier used for alert deduplication in Opsgenie. The alias must match the value used when creating the alert.
+ note:
+ type: string
+ description: Additional information for the alert.
+ source:
+ type: string
+ description: The display name for the source of the alert.
+ user:
+ type: string
+ description: The display name for the owner.
+ run_closeincident:
+ title: The closeIncident subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `closeIncident` subaction for ServiceNow ITSM connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - closeIncident
+ subActionParams:
+ type: object
+ required:
+ - incident
+ properties:
+ incident:
+ type: object
+ anyOf:
+ - required:
+ - correlation_id
+ - required:
+ - externalId
+ properties:
+ correlation_id:
+ type: string
+ nullable: true
+ description: |
+ An identifier that is assigned to the incident when it is created by the connector. NOTE: If you use the default value and the rule generates multiple alerts that use the same alert IDs, the latest open incident for this correlation ID is closed unless you specify the external ID.
+ maxLength: 100
+ default: '{{rule.id}}:{{alert.id}}'
+ externalId:
+ type: string
+ nullable: true
+ description: The unique identifier (`incidentId`) for the incident in ServiceNow.
+ run_createalert:
+ title: The createAlert subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `createAlert` subaction for Opsgenie and TheHive connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - createAlert
+ subActionParams:
+ type: object
+ properties:
+ actions:
+ type: array
+ description: The custom actions available to the alert in Opsgenie connectors.
+ items:
+ type: string
+ alias:
+ type: string
+ description: The unique identifier used for alert deduplication in Opsgenie.
+ description:
+ type: string
+ description: A description that provides detailed information about the alert.
+ details:
+ type: object
+ description: The custom properties of the alert in Opsgenie connectors.
+ additionalProperties: true
+ example:
+ key1: value1
+ key2: value2
+ entity:
+ type: string
+ description: The domain of the alert in Opsgenie connectors. For example, the application or server name.
+ message:
+ type: string
+ description: The alert message in Opsgenie connectors.
+ note:
+ type: string
+ description: Additional information for the alert in Opsgenie connectors.
+ priority:
+ type: string
+ description: The priority level for the alert in Opsgenie connectors.
+ enum:
+ - P1
+ - P2
+ - P3
+ - P4
+ - P5
+ responders:
+ type: array
+ description: |
+ The entities to receive notifications about the alert in Opsgenie connectors. If `type` is `user`, either `id` or `username` is required. If `type` is `team`, either `id` or `name` is required.
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The identifier for the entity.
+ name:
+ type: string
+ description: The name of the entity.
+ type:
+ type: string
+ description: The type of responders, in this case `escalation`.
+ enum:
+ - escalation
+ - schedule
+ - team
+ - user
+ username:
+ type: string
+ description: A valid email address for the user.
+ severity:
+ type: integer
+ minimum: 1
+ maximum: 4
+ description: |
+ The severity of the incident for TheHive connectors. The value ranges from 1 (low) to 4 (critical) with a default value of 2 (medium).
+ source:
+ type: string
+ description: The display name for the source of the alert in Opsgenie and TheHive connectors.
+ sourceRef:
+ type: string
+ description: A source reference for the alert in TheHive connectors.
+ tags:
+ type: array
+ description: The tags for the alert in Opsgenie and TheHive connectors.
+ items:
+ type: string
+ title:
+ type: string
+ description: |
+ A title for the incident for TheHive connectors. It is used for searching the contents of the knowledge base.
+ tlp:
+ type: integer
+ minimum: 0
+ maximum: 4
+ default: 2
+ description: |
+ The traffic light protocol designation for the incident in TheHive connectors. Valid values include: 0 (clear), 1 (green), 2 (amber), 3 (amber and strict), and 4 (red).
+ type:
+ type: string
+ description: The type of alert in TheHive connectors.
+ user:
+ type: string
+ description: The display name for the owner.
+ visibleTo:
+ type: array
+ description: The teams and users that the alert will be visible to without sending a notification. Only one of `id`, `name`, or `username` is required.
+ items:
+ type: object
+ required:
+ - type
+ properties:
+ id:
+ type: string
+ description: The identifier for the entity.
+ name:
+ type: string
+ description: The name of the entity.
+ type:
+ type: string
+ description: Valid values are `team` and `user`.
+ enum:
+ - team
+ - user
+ username:
+ type: string
+ description: The user name. This property is required only when the `type` is `user`.
+ run_fieldsbyissuetype:
+ title: The fieldsByIssueType subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `fieldsByIssueType` subaction for Jira connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - fieldsByIssueType
+ subActionParams:
+ type: object
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: The Jira issue type identifier.
+ example: 10024
+ run_getchoices:
+ title: The getChoices subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `getChoices` subaction for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - getChoices
+ subActionParams:
+ type: object
+ description: The set of configuration properties for the action.
+ required:
+ - fields
+ properties:
+ fields:
+ type: array
+ description: An array of fields.
+ items:
+ type: string
+ run_getfields:
+ title: The getFields subaction
+ type: object
+ required:
+ - subAction
+ description: The `getFields` subaction for Jira, ServiceNow ITSM, and ServiceNow SecOps connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - getFields
+ run_getincident:
+ title: The getIncident subaction
+ type: object
+ description: The `getIncident` subaction for Jira, ServiceNow ITSM, and ServiceNow SecOps connectors.
+ required:
+ - subAction
+ - subActionParams
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - getIncident
+ subActionParams:
+ type: object
+ required:
+ - externalId
+ properties:
+ externalId:
+ type: string
+ description: The Jira, ServiceNow ITSM, or ServiceNow SecOps issue identifier.
+ example: 71778
+ run_issue:
+ title: The issue subaction
+ type: object
+ required:
+ - subAction
+ description: The `issue` subaction for Jira connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - issue
+ subActionParams:
+ type: object
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: The Jira issue identifier.
+ example: 71778
+ run_issues:
+ title: The issues subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `issues` subaction for Jira connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - issues
+ subActionParams:
+ type: object
+ required:
+ - title
+ properties:
+ title:
+ type: string
+ description: The title of the Jira issue.
+ run_issuetypes:
+ title: The issueTypes subaction
+ type: object
+ required:
+ - subAction
+ description: The `issueTypes` subaction for Jira connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - issueTypes
+ run_postmessage:
+ title: The postMessage subaction
+ type: object
+ description: |
+ Test an action that sends a message to Slack. It is applicable only when the connector type is `.slack_api`.
+ required:
+ - subAction
+ - subActionParams
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - postMessage
+ subActionParams:
+ type: object
+ description: The set of configuration properties for the action.
+ properties:
+ channelIds:
+ type: array
+ maxItems: 1
+ description: |
+ The Slack channel identifier, which must be one of the `allowedChannels` in the connector configuration.
+ items:
+ type: string
+ channels:
+ type: array
+ deprecated: true
+ description: |
+ The name of a channel that your Slack app has access to.
+ maxItems: 1
+ items:
+ type: string
+ text:
+ type: string
+ description: |
+ The Slack message text. If it is a Slack webhook connector, the text cannot contain Markdown, images, or other advanced formatting. If it is a Slack web API connector, it can contain either plain text or block kit messages.
+ minLength: 1
+ run_pushtoservice:
+ title: The pushToService subaction
+ type: object
+ required:
+ - subAction
+ - subActionParams
+ description: The `pushToService` subaction for Jira, ServiceNow ITSM, ServiceNow SecOps, Swimlane, TheHive, and Webhook - Case Management connectors.
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - pushToService
+ subActionParams:
+ type: object
+ description: The set of configuration properties for the action.
+ properties:
+ comments:
+ type: array
+ description: Additional information that is sent to Jira, ServiceNow ITSM, ServiceNow SecOps, Swimlane, or TheHive.
+ items:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: A comment related to the incident. For example, describe how to troubleshoot the issue.
+ commentId:
+ type: integer
+ description: A unique identifier for the comment.
+ incident:
+ type: object
+ description: Information necessary to create or update a Jira, ServiceNow ITSM, ServiveNow SecOps, Swimlane, or TheHive incident.
+ properties:
+ additional_fields:
+ type: string
+ nullable: true
+ maxLength: 20
+ description: |
+ Additional fields for ServiceNow ITSM and ServiveNow SecOps connectors. The fields must exist in the Elastic ServiceNow application and must be specified in JSON format.
+ alertId:
+ type: string
+ description: The alert identifier for Swimlane connectors.
+ caseId:
+ type: string
+ description: The case identifier for the incident for Swimlane connectors.
+ caseName:
+ type: string
+ description: The case name for the incident for Swimlane connectors.
+ category:
+ type: string
+ description: The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
+ correlation_display:
+ type: string
+ description: A descriptive label of the alert for correlation purposes for ServiceNow ITSM and ServiceNow SecOps connectors.
+ correlation_id:
+ type: string
+ description: |
+ The correlation identifier for the security incident for ServiceNow ITSM and ServiveNow SecOps connectors. Connectors using the same correlation ID are associated with the same ServiceNow incident. This value determines whether a new ServiceNow incident is created or an existing one is updated. Modifying this value is optional; if not modified, the rule ID and alert ID are combined as `{{ruleID}}:{{alert ID}}` to form the correlation ID value in ServiceNow. The maximum character length for this value is 100 characters. NOTE: Using the default configuration of `{{ruleID}}:{{alert ID}}` ensures that ServiceNow creates a separate incident record for every generated alert that uses a unique alert ID. If the rule generates multiple alerts that use the same alert IDs, ServiceNow creates and continually updates a single incident record for the alert.
+ description:
+ type: string
+ description: The description of the incident for Jira, ServiceNow ITSM, ServiceNow SecOps, Swimlane, TheHive, and Webhook - Case Management connectors.
+ dest_ip:
+ description: |
+ A list of destination IP addresses related to the security incident for ServiceNow SecOps connectors. The IPs are added as observables to the security incident.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ externalId:
+ type: string
+ description: |
+ The Jira, ServiceNow ITSM, or ServiceNow SecOps issue identifier. If present, the incident is updated. Otherwise, a new incident is created.
+ id:
+ type: string
+ description: The external case identifier for Webhook - Case Management connectors.
+ impact:
+ type: string
+ description: The impact of the incident for ServiceNow ITSM connectors.
+ issueType:
+ type: integer
+ description: The type of incident for Jira connectors. For example, 10006. To obtain the list of valid values, set `subAction` to `issueTypes`.
+ labels:
+ type: array
+ items:
+ type: string
+ description: |
+ The labels for the incident for Jira connectors. NOTE: Labels cannot contain spaces.
+ malware_hash:
+ description: A list of malware hashes related to the security incident for ServiceNow SecOps connectors. The hashes are added as observables to the security incident.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ malware_url:
+ type: string
+ description: A list of malware URLs related to the security incident for ServiceNow SecOps connectors. The URLs are added as observables to the security incident.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ otherFields:
+ type: object
+ additionalProperties: true
+ maxProperties: 20
+ description: |
+ Custom field identifiers and their values for Jira connectors.
+ parent:
+ type: string
+ description: The ID or key of the parent issue for Jira connectors. Applies only to `Sub-task` types of issues.
+ priority:
+ type: string
+ description: The priority of the incident in Jira and ServiceNow SecOps connectors.
+ ruleName:
+ type: string
+ description: The rule name for Swimlane connectors.
+ severity:
+ type: integer
+ description: |
+ The severity of the incident for ServiceNow ITSM, Swimlane, and TheHive connectors. In TheHive connectors, the severity value ranges from 1 (low) to 4 (critical) with a default value of 2 (medium).
+ short_description:
+ type: string
+ description: |
+ A short description of the incident for ServiceNow ITSM and ServiceNow SecOps connectors. It is used for searching the contents of the knowledge base.
+ source_ip:
+ description: A list of source IP addresses related to the security incident for ServiceNow SecOps connectors. The IPs are added as observables to the security incident.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ status:
+ type: string
+ description: The status of the incident for Webhook - Case Management connectors.
+ subcategory:
+ type: string
+ description: The subcategory of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
+ summary:
+ type: string
+ description: A summary of the incident for Jira connectors.
+ tags:
+ type: array
+ items:
+ type: string
+ description: A list of tags for TheHive and Webhook - Case Management connectors.
+ title:
+ type: string
+ description: |
+ A title for the incident for Jira, TheHive, and Webhook - Case Management connectors. It is used for searching the contents of the knowledge base.
+ tlp:
+ type: integer
+ minimum: 0
+ maximum: 4
+ default: 2
+ description: |
+ The traffic light protocol designation for the incident in TheHive connectors. Valid values include: 0 (clear), 1 (green), 2 (amber), 3 (amber and strict), and 4 (red).
+ urgency:
+ type: string
+ description: The urgency of the incident for ServiceNow ITSM connectors.
+ run_validchannelid:
+ title: The validChannelId subaction
+ type: object
+ description: |
+ Retrieves information about a valid Slack channel identifier. It is applicable only when the connector type is `.slack_api`.
+ required:
+ - subAction
+ - subActionParams
+ properties:
+ subAction:
+ type: string
+ description: The action to test.
+ enum:
+ - validChannelId
+ subActionParams:
+ type: object
+ required:
+ - channelId
+ properties:
+ channelId:
+ type: string
+ description: The Slack channel identifier.
+ example: C123ABC456
+ params_property_apm_anomaly:
+ required:
+ - windowSize
+ - windowUnit
+ - environment
+ - anomalySeverityType
+ properties:
+ serviceName:
+ type: string
+ description: The service name from APM
+ transactionType:
+ type: string
+ description: The transaction type from APM
+ windowSize:
+ type: number
+ example: 6
+ description: The window size
+ windowUnit:
+ type: string
+ description: The window size unit
+ enum:
+ - m
+ - h
+ - d
+ environment:
+ type: string
+ description: The environment from APM
+ anomalySeverityType:
+ type: string
+ description: The anomaly threshold value
+ enum:
+ - critical
+ - major
+ - minor
+ - warning
+ params_property_apm_error_count:
+ required:
+ - windowSize
+ - windowUnit
+ - threshold
+ - environment
+ properties:
+ serviceName:
+ type: string
+ description: The service name from APM
+ windowSize:
+ type: number
+ description: The window size
+ example: 6
+ windowUnit:
+ type: string
+ description: The window size unit
+ enum:
+ - m
+ - h
+ - d
+ environment:
+ type: string
+ description: The environment from APM
+ threshold:
+ type: number
+ description: The error count threshold value
+ groupBy:
+ type: array
+ default:
+ - service.name
+ - service.environment
+ uniqueItems: true
+ items:
+ type: string
+ enum:
+ - service.name
+ - service.environment
+ - transaction.name
+ - error.grouping_key
+ errorGroupingKey:
+ type: string
+ params_property_apm_transaction_duration:
+ required:
+ - windowSize
+ - windowUnit
+ - threshold
+ - environment
+ - aggregationType
+ properties:
+ serviceName:
+ type: string
+ description: The service name from APM
+ transactionType:
+ type: string
+ description: The transaction type from APM
+ transactionName:
+ type: string
+ description: The transaction name from APM
+ windowSize:
+ type: number
+ description: The window size
+ example: 6
+ windowUnit:
+ type: string
+ description: ç
+ enum:
+ - m
+ - h
+ - d
+ environment:
+ type: string
+ threshold:
+ type: number
+ description: The latency threshold value
+ groupBy:
+ type: array
+ default:
+ - service.name
+ - service.environment
+ - transaction.type
+ uniqueItems: true
+ items:
+ type: string
+ enum:
+ - service.name
+ - service.environment
+ - transaction.type
+ - transaction.name
+ aggregationType:
+ type: string
+ enum:
+ - avg
+ - 95th
+ - 99th
+ params_property_apm_transaction_error_rate:
+ required:
+ - windowSize
+ - windowUnit
+ - threshold
+ - environment
+ properties:
+ serviceName:
+ type: string
+ description: The service name from APM
+ transactionType:
+ type: string
+ description: The transaction type from APM
+ transactionName:
+ type: string
+ description: The transaction name from APM
+ windowSize:
+ type: number
+ description: The window size
+ example: 6
+ windowUnit:
+ type: string
+ description: The window size unit
+ enum:
+ - m
+ - h
+ - d
+ environment:
+ type: string
+ description: The environment from APM
+ threshold:
+ type: number
+ description: The error rate threshold value
+ groupBy:
+ type: array
+ default:
+ - service.name
+ - service.environment
+ - transaction.type
+ uniqueItems: true
+ items:
+ type: string
+ enum:
+ - service.name
+ - service.environment
+ - transaction.type
+ - transaction.name
+ aggfield:
+ description: |
+ The name of the numeric field that is used in the aggregation. This property is required when `aggType` is `avg`, `max`, `min` or `sum`.
+ type: string
+ aggtype:
+ description: The type of aggregation to perform.
+ type: string
+ enum:
+ - avg
+ - count
+ - max
+ - min
+ - sum
+ default: count
+ excludehitsfrompreviousrun:
+ description: |
+ Indicates whether to exclude matches from previous runs. If `true`, you can avoid alert duplication by excluding documents that have already been detected by the previous rule run. This option is not available when a grouping field is specified.
+ type: boolean
+ groupby:
+ description: |
+ Indicates whether the aggregation is applied over all documents (`all`) or split into groups (`top`) using a grouping field (`termField`). If grouping is used, an alert will be created for each group when it exceeds the threshold; only the top groups (up to `termSize` number of groups) are checked.
+ type: string
+ enum:
+ - all
+ - top
+ default: all
+ size:
+ description: |
+ The number of documents to pass to the configured actions when the threshold condition is met.
+ type: integer
+ termfield:
+ description: |
+ The names of up to four fields that are used for grouping the aggregation. This property is required when `groupBy` is `top`.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ maxItems: 4
+ termsize:
+ description: |
+ This property is required when `groupBy` is `top`. It specifies the number of groups to check against the threshold and therefore limits the number of alerts on high cardinality fields.
+ type: integer
+ threshold:
+ description: |
+ The threshold value that is used with the `thresholdComparator`. If the `thresholdComparator` is `between` or `notBetween`, you must specify the boundary values.
+ type: array
+ items:
+ type: integer
+ example: 4000
+ thresholdcomparator:
+ description: The comparison function for the threshold. For example, "is above", "is above or equals", "is below", "is below or equals", "is between", and "is not between".
+ type: string
+ enum:
+ - '>'
+ - '>='
+ - <
+ - <=
+ - between
+ - notBetween
+ example: '>'
+ timefield:
+ description: The field that is used to calculate the time window.
+ type: string
+ timewindowsize:
+ description: |
+ The size of the time window (in `timeWindowUnit` units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
+ type: integer
+ example: 5
+ timewindowunit:
+ description: |
+ The type of units for the time window: seconds, minutes, hours, or days.
+ type: string
+ enum:
+ - s
+ - m
+ - h
+ - d
+ example: m
+ params_es_query_dsl_rule:
+ title: Elasticsearch DSL query rule params
+ description: |
+ An Elasticsearch query rule can run a query defined in Elasticsearch Query DSL and compare the number of matches to a configured threshold. These parameters are appropriate when `rule_type_id` is `.es-query`.
+ type: object
+ required:
+ - esQuery
+ - index
+ - threshold
+ - thresholdComparator
+ - timeField
+ - timeWindowSize
+ - timeWindowUnit
+ properties:
+ aggField:
+ $ref: '#/components/schemas/aggfield'
+ aggType:
+ $ref: '#/components/schemas/aggtype'
+ esQuery:
+ description: The query definition, which uses Elasticsearch Query DSL.
+ type: string
+ excludeHitsFromPreviousRun:
+ $ref: '#/components/schemas/excludehitsfrompreviousrun'
+ groupBy:
+ $ref: '#/components/schemas/groupby'
+ index:
+ description: The indices to query.
+ oneOf:
+ - type: array
+ items:
+ type: string
+ - type: string
+ searchType:
+ description: The type of query, in this case a query that uses Elasticsearch Query DSL.
+ type: string
+ enum:
+ - esQuery
+ default: esQuery
+ example: esQuery
+ size:
+ $ref: '#/components/schemas/size'
+ termField:
+ $ref: '#/components/schemas/termfield'
+ termSize:
+ $ref: '#/components/schemas/termsize'
+ threshold:
+ $ref: '#/components/schemas/threshold'
+ thresholdComparator:
+ $ref: '#/components/schemas/thresholdcomparator'
+ timeField:
+ $ref: '#/components/schemas/timefield'
+ timeWindowSize:
+ $ref: '#/components/schemas/timewindowsize'
+ timeWindowUnit:
+ $ref: '#/components/schemas/timewindowunit'
+ params_es_query_esql_rule:
+ title: Elasticsearch ES|QL query rule params
+ description: |
+ An Elasticsearch query rule can run an ES|QL query and compare the number of matches to a configured threshold. These parameters are appropriate when `rule_type_id` is `.es-query`.
+ type: object
+ required:
+ - esqlQuery
+ - searchType
+ - size
+ - threshold
+ - thresholdComparator
+ - timeWindowSize
+ - timeWindowUnit
+ properties:
+ aggField:
+ $ref: '#/components/schemas/aggfield'
+ aggType:
+ $ref: '#/components/schemas/aggtype'
+ esqlQuery:
+ type: object
+ required:
+ - esql
+ properties:
+ esql:
+ description: The query definition, which uses Elasticsearch Query Language.
+ type: string
+ excludeHitsFromPreviousRun:
+ $ref: '#/components/schemas/excludehitsfrompreviousrun'
+ groupBy:
+ $ref: '#/components/schemas/groupby'
+ searchType:
+ description: The type of query, in this case a query that uses Elasticsearch Query Language (ES|QL).
+ type: string
+ enum:
+ - esqlQuery
+ example: esqlQuery
+ size:
+ type: integer
+ description: |
+ When `searchType` is `esqlQuery`, this property is required but it does not affect the rule behavior.
+ example: 0
+ termSize:
+ $ref: '#/components/schemas/termsize'
+ threshold:
+ type: array
+ items:
+ type: integer
+ minimum: 0
+ maximum: 0
+ description: |
+ The threshold value that is used with the `thresholdComparator`. When `searchType` is `esqlQuery`, this property is required and must be set to zero.
+ thresholdComparator:
+ type: string
+ description: |
+ The comparison function for the threshold. When `searchType` is `esqlQuery`, this property is required and must be set to ">". Since the `threshold` value must be `0`, the result is that an alert occurs whenever the query returns results.
+ enum:
+ - '>'
+ example: '>'
+ timeField:
+ $ref: '#/components/schemas/timefield'
+ timeWindowSize:
+ $ref: '#/components/schemas/timewindowsize'
+ timeWindowUnit:
+ $ref: '#/components/schemas/timewindowunit'
+ filter:
+ type: object
+ description: A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the `kbn-es-query` package.
+ properties:
+ meta:
+ type: object
+ properties:
+ alias:
+ type: string
+ nullable: true
+ controlledBy:
+ type: string
+ disabled:
+ type: boolean
+ field:
+ type: string
+ group:
+ type: string
+ index:
+ type: string
+ isMultiIndex:
+ type: boolean
+ key:
+ type: string
+ negate:
+ type: boolean
+ params:
+ type: object
+ type:
+ type: string
+ value:
+ type: string
+ query:
+ type: object
+ $state:
+ type: object
+ params_es_query_kql_rule:
+ title: Elasticsearch KQL query rule params
+ description: |
+ An Elasticsearch query rule can run a query defined in KQL or Lucene and compare the number of matches to a configured threshold. These parameters are appropriate when `rule_type_id` is `.es-query`.
+ type: object
+ required:
+ - searchType
+ - size
+ - threshold
+ - thresholdComparator
+ - timeWindowSize
+ - timeWindowUnit
+ properties:
+ aggField:
+ $ref: '#/components/schemas/aggfield'
+ aggType:
+ $ref: '#/components/schemas/aggtype'
+ excludeHitsFromPreviousRun:
+ $ref: '#/components/schemas/excludehitsfrompreviousrun'
+ groupBy:
+ $ref: '#/components/schemas/groupby'
+ searchConfiguration:
+ description: The query definition, which uses KQL or Lucene to fetch the documents from Elasticsearch.
+ type: object
+ properties:
+ filter:
+ type: array
+ items:
+ $ref: '#/components/schemas/filter'
+ index:
+ description: The indices to query.
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ query:
+ type: object
+ properties:
+ language:
+ type: string
+ example: kuery
+ query:
+ type: string
+ searchType:
+ description: The type of query, in this case a text-based query that uses KQL or Lucene.
+ type: string
+ enum:
+ - searchSource
+ example: searchSource
+ size:
+ $ref: '#/components/schemas/size'
+ termField:
+ $ref: '#/components/schemas/termfield'
+ termSize:
+ $ref: '#/components/schemas/termsize'
+ threshold:
+ $ref: '#/components/schemas/threshold'
+ thresholdComparator:
+ $ref: '#/components/schemas/thresholdcomparator'
+ timeField:
+ $ref: '#/components/schemas/timefield'
+ timeWindowSize:
+ $ref: '#/components/schemas/timewindowsize'
+ timeWindowUnit:
+ $ref: '#/components/schemas/timewindowunit'
+ params_index_threshold_rule:
+ title: Index threshold rule params
+ description: An index threshold rule runs an Elasticsearch query, aggregates field values from documents, compares them to threshold values, and schedules actions to run when the thresholds are met. These parameters are appropriate when `rule_type_id` is `.index-threshold`.
+ type: object
+ required:
+ - index
+ - threshold
+ - thresholdComparator
+ - timeField
+ - timeWindowSize
+ - timeWindowUnit
+ properties:
+ aggField:
+ $ref: '#/components/schemas/aggfield'
+ aggType:
+ $ref: '#/components/schemas/aggtype'
+ filterKuery:
+ description: A KQL expression thats limits the scope of alerts.
+ type: string
+ groupBy:
+ $ref: '#/components/schemas/groupby'
+ index:
+ description: The indices to query.
+ type: array
+ items:
+ type: string
+ termField:
+ $ref: '#/components/schemas/termfield'
+ termSize:
+ $ref: '#/components/schemas/termsize'
+ threshold:
+ $ref: '#/components/schemas/threshold'
+ thresholdComparator:
+ $ref: '#/components/schemas/thresholdcomparator'
+ timeField:
+ $ref: '#/components/schemas/timefield'
+ timeWindowSize:
+ $ref: '#/components/schemas/timewindowsize'
+ timeWindowUnit:
+ $ref: '#/components/schemas/timewindowunit'
+ params_property_infra_inventory:
+ properties:
+ criteria:
+ type: array
+ items:
+ type: object
+ properties:
+ metric:
+ type: string
+ enum:
+ - count
+ - cpu
+ - diskLatency
+ - load
+ - memory
+ - memoryTotal
+ - tx
+ - rx
+ - logRate
+ - diskIOReadBytes
+ - diskIOWriteBytes
+ - s3TotalRequests
+ - s3NumberOfObjects
+ - s3BucketSize
+ - s3DownloadBytes
+ - s3UploadBytes
+ - rdsConnections
+ - rdsQueriesExecuted
+ - rdsActiveTransactions
+ - rdsLatency
+ - sqsMessagesVisible
+ - sqsMessagesDelayed
+ - sqsMessagesSent
+ - sqsMessagesEmpty
+ - sqsOldestMessage
+ - custom
+ timeSize:
+ type: number
+ timeUnit:
+ type: string
+ enum:
+ - s
+ - m
+ - h
+ - d
+ sourceId:
+ type: string
+ threshold:
+ type: array
+ items:
+ type: number
+ comparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ customMetric:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - custom
+ field:
+ type: string
+ aggregation:
+ type: string
+ enum:
+ - avg
+ - max
+ - min
+ - rate
+ id:
+ type: string
+ label:
+ type: string
+ warningThreshold:
+ type: array
+ items:
+ type: number
+ warningComparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ filterQuery:
+ type: string
+ filterQueryText:
+ type: string
+ nodeType:
+ type: string
+ enum:
+ - host
+ - pod
+ - container
+ - awsEC2
+ - awsS3
+ - awsSQS
+ - awsRDS
+ sourceId:
+ type: string
+ alertOnNoData:
+ type: boolean
+ params_property_log_threshold:
+ oneOf:
+ - title: Count
+ type: object
+ required:
+ - count
+ - timeSize
+ - timeUnit
+ - logView
+ properties:
+ criteria:
+ type: array
+ items:
+ type: object
+ properties:
+ field:
+ type: string
+ example: my.field
+ comparator:
+ type: string
+ enum:
+ - more than
+ - more than or equals
+ - less than
+ - less than or equals
+ - equals
+ - does not equal
+ - matches
+ - does not match
+ - matches phrase
+ - does not match phrase
+ value:
+ oneOf:
+ - type: number
+ example: 42
+ - type: string
+ example: value
+ count:
+ type: object
+ properties:
+ comparator:
+ type: string
+ enum:
+ - more than
+ - more than or equals
+ - less than
+ - less than or equals
+ - equals
+ - does not equal
+ - matches
+ - does not match
+ - matches phrase
+ - does not match phrase
+ value:
+ type: number
+ example: 100
+ timeSize:
+ type: number
+ example: 6
+ timeUnit:
+ type: string
+ enum:
+ - s
+ - m
+ - h
+ - d
+ logView:
+ type: object
+ properties:
+ logViewId:
+ type: string
+ type:
+ type: string
+ enum:
+ - log-view-reference
+ example: log-view-reference
+ groupBy:
+ type: array
+ items:
+ type: string
+ - title: Ratio
+ type: object
+ required:
+ - count
+ - timeSize
+ - timeUnit
+ - logView
+ properties:
+ criteria:
+ type: array
+ items:
+ minItems: 2
+ maxItems: 2
+ type: array
+ items:
+ type: object
+ properties:
+ field:
+ type: string
+ example: my.field
+ comparator:
+ type: string
+ enum:
+ - more than
+ - more than or equals
+ - less than
+ - less than or equals
+ - equals
+ - does not equal
+ - matches
+ - does not match
+ - matches phrase
+ - does not match phrase
+ value:
+ oneOf:
+ - type: number
+ example: 42
+ - type: string
+ example: value
+ count:
+ type: object
+ properties:
+ comparator:
+ type: string
+ enum:
+ - more than
+ - more than or equals
+ - less than
+ - less than or equals
+ - equals
+ - does not equal
+ - matches
+ - does not match
+ - matches phrase
+ - does not match phrase
+ value:
+ type: number
+ example: 100
+ timeSize:
+ type: number
+ example: 6
+ timeUnit:
+ type: string
+ enum:
+ - s
+ - m
+ - h
+ - d
+ logView:
+ type: object
+ properties:
+ logViewId:
+ type: string
+ type:
+ type: string
+ enum:
+ - log-view-reference
+ example: log-view-reference
+ groupBy:
+ type: array
+ items:
+ type: string
+ params_property_infra_metric_threshold:
+ properties:
+ criteria:
+ type: array
+ items:
+ oneOf:
+ - title: non count criterion
+ type: object
+ properties:
+ threshold:
+ type: array
+ items:
+ type: number
+ comparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ timeUnit:
+ type: string
+ timeSize:
+ type: number
+ warningThreshold:
+ type: array
+ items:
+ type: number
+ warningComparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ metric:
+ type: string
+ aggType:
+ type: string
+ enum:
+ - avg
+ - max
+ - min
+ - cardinality
+ - rate
+ - count
+ - sum
+ - p95
+ - p99
+ - custom
+ - title: count criterion
+ type: object
+ properties:
+ threshold:
+ type: array
+ items:
+ type: number
+ comparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ timeUnit:
+ type: string
+ timeSize:
+ type: number
+ warningThreshold:
+ type: array
+ items:
+ type: number
+ warningComparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ aggType:
+ type: string
+ enum:
+ - count
+ - title: custom criterion
+ type: object
+ properties:
+ threshold:
+ type: array
+ items:
+ type: number
+ comparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ timeUnit:
+ type: string
+ timeSize:
+ type: number
+ warningThreshold:
+ type: array
+ items:
+ type: number
+ warningComparator:
+ type: string
+ enum:
+ - <
+ - <=
+ - '>'
+ - '>='
+ - between
+ - outside
+ aggType:
+ type: string
+ enum:
+ - custom
+ customMetric:
+ type: array
+ items:
+ oneOf:
+ - type: object
+ properties:
+ name:
+ type: string
+ aggType:
+ type: string
+ enum:
+ - avg
+ - sum
+ - max
+ - min
+ - cardinality
+ field:
+ type: string
+ - type: object
+ properties:
+ name:
+ type: string
+ aggType:
+ type: string
+ enum:
+ - count
+ filter:
+ type: string
+ equation:
+ type: string
+ label:
+ type: string
+ groupBy:
+ oneOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ filterQuery:
+ type: string
+ sourceId:
+ type: string
+ alertOnNoData:
+ type: boolean
+ alertOnGroupDisappear:
+ type: boolean
+ params_property_slo_burn_rate:
+ properties:
+ sloId:
+ description: The SLO identifier used by the rule
+ type: string
+ example: 8853df00-ae2e-11ed-90af-09bb6422b258
+ burnRateThreshold:
+ description: The burn rate threshold used to trigger the alert
+ type: number
+ example: 14.4
+ maxBurnRateThreshold:
+ description: The maximum burn rate threshold value defined by the SLO error budget
+ type: number
+ example: 168
+ longWindow:
+ description: The duration of the long window used to compute the burn rate
+ type: object
+ properties:
+ value:
+ description: The duration value
+ type: number
+ example: 6
+ unit:
+ description: The duration unit
+ type: string
+ example: h
+ shortWindow:
+ description: The duration of the short window used to compute the burn rate
+ type: object
+ properties:
+ value:
+ description: The duration value
+ type: number
+ example: 30
+ unit:
+ description: The duration unit
+ type: string
+ example: m
+ params_property_synthetics_uptime_tls:
+ properties:
+ search:
+ type: string
+ certExpirationThreshold:
+ type: number
+ certAgeThreshold:
+ type: number
+ params_property_synthetics_monitor_status:
+ required:
+ - numTimes
+ - shouldCheckStatus
+ - shouldCheckAvailability
+ properties:
+ availability:
+ type: object
+ properties:
+ range:
+ type: number
+ rangeUnit:
+ type: string
+ threshold:
+ type: string
+ filters:
+ oneOf:
+ - type: string
+ - type: object
+ deprecated: true
+ properties:
+ monitor.type:
+ type: array
+ items:
+ type: string
+ observer.geo.name:
+ type: array
+ items:
+ type: string
+ tags:
+ type: array
+ items:
+ type: string
+ url.port:
+ type: array
+ items:
+ type: string
+ locations:
+ deprecated: true
+ type: array
+ items:
+ type: string
+ numTimes:
+ type: number
+ search:
+ type: string
+ shouldCheckStatus:
+ type: boolean
+ shouldCheckAvailability:
+ type: boolean
+ timerangeCount:
+ type: number
+ timerangeUnit:
+ type: string
+ timerange:
+ deprecated: true
+ type: object
+ properties:
+ from:
+ type: string
+ to:
+ type: string
+ version:
+ type: number
+ isAutoGenerated:
+ type: boolean
+ securitySchemes:
+ apiKeyAuth:
+ description: |
+ These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: `Authorization: ApiKey base64AccessApiKey`
+ in: header
+ name: Authorization
+ type: apiKey
+ basicAuth:
+ scheme: basic
+ type: http
+x-topics:
+ - title: Kibana spaces
+ content: |
+ Spaces enable you to organize your dashboards and other saved objects into meaningful categories.
+ You can use the default space or create your own spaces.
+
+ To run APIs in non-default spaces, you must add `s/{space_id}/` to the path.
+ For example:
+
+ ```
+ curl -X GET "http://localhost:5601/s/marketing/api/data_views"
+ ```
+
+ If you use the Kibana console to send API requests, it automatically adds the appropriate space identifier.
+
+ To learn more, check out [Spaces](https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html).
diff --git a/oas_docs/package-lock.json b/oas_docs/package-lock.json
new file mode 100644
index 0000000000000..70fff86254f65
--- /dev/null
+++ b/oas_docs/package-lock.json
@@ -0,0 +1,4638 @@
+{
+ "name": "oas_docs",
+ "version": "1.0.0",
+ "lockfileVersion": 3,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "oas_docs",
+ "version": "1.0.0",
+ "license": "ISC",
+ "dependencies": {
+ "@redocly/cli": "^1.25.11",
+ "bump-cli": "^2.8.4"
+ }
+ },
+ "node_modules/@apidevtools/json-schema-ref-parser": {
+ "version": "9.1.2",
+ "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz",
+ "integrity": "sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==",
+ "dependencies": {
+ "@jsdevtools/ono": "^7.1.3",
+ "@types/json-schema": "^7.0.6",
+ "call-me-maybe": "^1.0.1",
+ "js-yaml": "^4.1.0"
+ }
+ },
+ "node_modules/@asyncapi/specs": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/@asyncapi/specs/-/specs-5.1.0.tgz",
+ "integrity": "sha512-yffhETqehkim43luMnPKOwzY0D0YtU4bKpORIXIaid6p5Y5kDLrMGJaEPkNieQp03HMjhjFrnUPtT8kvqe0+aQ==",
+ "dependencies": {
+ "@types/json-schema": "^7.0.11"
+ }
+ },
+ "node_modules/@babel/runtime": {
+ "version": "7.26.0",
+ "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.26.0.tgz",
+ "integrity": "sha512-FDSOghenHTiToteC/QRlv2q3DhPZ/oOXTBoirfWNx1Cx3TMVcGWQtMMmQcSvb/JjpNeGzx8Pq/b4fKEJuWm1sw==",
+ "dependencies": {
+ "regenerator-runtime": "^0.14.0"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@cfaester/enzyme-adapter-react-18": {
+ "version": "0.8.0",
+ "resolved": "https://registry.npmjs.org/@cfaester/enzyme-adapter-react-18/-/enzyme-adapter-react-18-0.8.0.tgz",
+ "integrity": "sha512-3Z3ThTUouHwz8oIyhTYQljEMNRFtlVyc3VOOHCbxs47U6cnXs8K9ygi/c1tv49s7MBlTXeIcuN+Ttd9aPtILFQ==",
+ "dependencies": {
+ "enzyme-shallow-equal": "^1.0.0",
+ "function.prototype.name": "^1.1.6",
+ "has": "^1.0.4",
+ "react-is": "^18.2.0",
+ "react-shallow-renderer": "^16.15.0"
+ },
+ "peerDependencies": {
+ "enzyme": "^3.11.0",
+ "react": ">=18",
+ "react-dom": ">=18"
+ }
+ },
+ "node_modules/@clack/core": {
+ "version": "0.3.4",
+ "resolved": "https://registry.npmjs.org/@clack/core/-/core-0.3.4.tgz",
+ "integrity": "sha512-H4hxZDXgHtWTwV3RAVenqcC4VbJZNegbBjlPvzOzCouXtS2y3sDvlO3IsbrPNWuLWPPlYVYPghQdSF64683Ldw==",
+ "dependencies": {
+ "picocolors": "^1.0.0",
+ "sisteransi": "^1.0.5"
+ }
+ },
+ "node_modules/@clack/prompts": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/@clack/prompts/-/prompts-0.6.3.tgz",
+ "integrity": "sha512-AM+kFmAHawpUQv2q9+mcB6jLKxXGjgu/r2EQjEwujgpCdzrST6BJqYw00GRn56/L/Izw5U7ImoLmy00X/r80Pw==",
+ "bundleDependencies": [
+ "is-unicode-supported"
+ ],
+ "dependencies": {
+ "@clack/core": "^0.3.2",
+ "is-unicode-supported": "*",
+ "picocolors": "^1.0.0",
+ "sisteransi": "^1.0.5"
+ }
+ },
+ "node_modules/@clack/prompts/node_modules/is-unicode-supported": {
+ "version": "1.3.0",
+ "inBundle": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/@cspotcode/source-map-support": {
+ "version": "0.8.1",
+ "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz",
+ "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==",
+ "dependencies": {
+ "@jridgewell/trace-mapping": "0.3.9"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@emotion/is-prop-valid": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/@emotion/is-prop-valid/-/is-prop-valid-1.2.2.tgz",
+ "integrity": "sha512-uNsoYd37AFmaCdXlg6EYD1KaPOaRWRByMCYzbKUX4+hhMfrxdVSelShywL4JVaAeM/eHUOSprYBQls+/neX3pw==",
+ "dependencies": {
+ "@emotion/memoize": "^0.8.1"
+ }
+ },
+ "node_modules/@emotion/memoize": {
+ "version": "0.8.1",
+ "resolved": "https://registry.npmjs.org/@emotion/memoize/-/memoize-0.8.1.tgz",
+ "integrity": "sha512-W2P2c/VRW1/1tLox0mVUalvnWXxavmv/Oum2aPsRcoDJuob75FC3Y8FbpfLwUegRcxINtGUMPq0tFCvYNTBXNA=="
+ },
+ "node_modules/@emotion/unitless": {
+ "version": "0.8.1",
+ "resolved": "https://registry.npmjs.org/@emotion/unitless/-/unitless-0.8.1.tgz",
+ "integrity": "sha512-KOEGMu6dmJZtpadb476IsZBclKvILjopjUii3V+7MnXIQCYh8W3NgNcgwo21n9LXZX6EDIKvqfjYxXebDwxKmQ=="
+ },
+ "node_modules/@exodus/schemasafe": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/@exodus/schemasafe/-/schemasafe-1.3.0.tgz",
+ "integrity": "sha512-5Aap/GaRupgNx/feGBwLLTVv8OQFfv3pq2lPRzPg9R+IOBnDgghTGW7l7EuVXOvg5cc/xSAlRW8rBrjIC3Nvqw=="
+ },
+ "node_modules/@jridgewell/resolve-uri": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz",
+ "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==",
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/@jridgewell/sourcemap-codec": {
+ "version": "1.5.0",
+ "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz",
+ "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ=="
+ },
+ "node_modules/@jridgewell/trace-mapping": {
+ "version": "0.3.9",
+ "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz",
+ "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==",
+ "dependencies": {
+ "@jridgewell/resolve-uri": "^3.0.3",
+ "@jridgewell/sourcemap-codec": "^1.4.10"
+ }
+ },
+ "node_modules/@jsdevtools/ono": {
+ "version": "7.1.3",
+ "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz",
+ "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg=="
+ },
+ "node_modules/@nodelib/fs.scandir": {
+ "version": "2.1.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
+ "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
+ "dependencies": {
+ "@nodelib/fs.stat": "2.0.5",
+ "run-parallel": "^1.1.9"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.stat": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
+ "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.walk": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
+ "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
+ "dependencies": {
+ "@nodelib/fs.scandir": "2.1.5",
+ "fastq": "^1.6.0"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@oclif/command": {
+ "version": "1.8.36",
+ "resolved": "https://registry.npmjs.org/@oclif/command/-/command-1.8.36.tgz",
+ "integrity": "sha512-/zACSgaYGtAQRzc7HjzrlIs14FuEYAZrMOEwicRoUnZVyRunG4+t5iSEeQu0Xy2bgbCD0U1SP/EdeNZSTXRwjQ==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/config": "^1.18.2",
+ "@oclif/errors": "^1.3.6",
+ "@oclif/help": "^1.0.1",
+ "@oclif/parser": "^3.8.17",
+ "debug": "^4.1.1",
+ "semver": "^7.5.4"
+ },
+ "engines": {
+ "node": ">=12.0.0"
+ },
+ "peerDependencies": {
+ "@oclif/config": "^1"
+ }
+ },
+ "node_modules/@oclif/config": {
+ "version": "1.18.17",
+ "resolved": "https://registry.npmjs.org/@oclif/config/-/config-1.18.17.tgz",
+ "integrity": "sha512-k77qyeUvjU8qAJ3XK3fr/QVAqsZO8QOBuESnfeM5HHtPNLSyfVcwiMM2zveSW5xRdLSG3MfV8QnLVkuyCL2ENg==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/errors": "^1.3.6",
+ "@oclif/parser": "^3.8.17",
+ "debug": "^4.3.4",
+ "globby": "^11.1.0",
+ "is-wsl": "^2.1.1",
+ "tslib": "^2.6.1"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/core": {
+ "version": "1.20.4",
+ "resolved": "https://registry.npmjs.org/@oclif/core/-/core-1.20.4.tgz",
+ "integrity": "sha512-giug32M4YhSYNYKQwE1L57/+k5gp1+Bq3/0vKNQmzAY1tizFGhvBJc6GIRZasHjU+xtZLutQvrVrJo7chX3hxg==",
+ "dependencies": {
+ "@oclif/linewrap": "^1.0.0",
+ "@oclif/screen": "^3.0.3",
+ "ansi-escapes": "^4.3.2",
+ "ansi-styles": "^4.3.0",
+ "cardinal": "^2.1.1",
+ "chalk": "^4.1.2",
+ "clean-stack": "^3.0.1",
+ "cli-progress": "^3.10.0",
+ "debug": "^4.3.4",
+ "ejs": "^3.1.6",
+ "fs-extra": "^9.1.0",
+ "get-package-type": "^0.1.0",
+ "globby": "^11.1.0",
+ "hyperlinker": "^1.0.0",
+ "indent-string": "^4.0.0",
+ "is-wsl": "^2.2.0",
+ "js-yaml": "^3.14.1",
+ "natural-orderby": "^2.0.3",
+ "object-treeify": "^1.1.33",
+ "password-prompt": "^1.1.2",
+ "semver": "^7.3.7",
+ "string-width": "^4.2.3",
+ "strip-ansi": "^6.0.1",
+ "supports-color": "^8.1.1",
+ "supports-hyperlinks": "^2.2.0",
+ "tslib": "^2.4.1",
+ "widest-line": "^3.1.0",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=14.0.0"
+ }
+ },
+ "node_modules/@oclif/core/node_modules/argparse": {
+ "version": "1.0.10",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
+ "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
+ "dependencies": {
+ "sprintf-js": "~1.0.2"
+ }
+ },
+ "node_modules/@oclif/core/node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@oclif/core/node_modules/js-yaml": {
+ "version": "3.14.1",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
+ "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
+ "dependencies": {
+ "argparse": "^1.0.7",
+ "esprima": "^4.0.0"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/@oclif/errors": {
+ "version": "1.3.6",
+ "resolved": "https://registry.npmjs.org/@oclif/errors/-/errors-1.3.6.tgz",
+ "integrity": "sha512-fYaU4aDceETd89KXP+3cLyg9EHZsLD3RxF2IU9yxahhBpspWjkWi3Dy3bTgcwZ3V47BgxQaGapzJWDM33XIVDQ==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "clean-stack": "^3.0.0",
+ "fs-extra": "^8.1",
+ "indent-string": "^4.0.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/errors/node_modules/fs-extra": {
+ "version": "8.1.0",
+ "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz",
+ "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==",
+ "dependencies": {
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^4.0.0",
+ "universalify": "^0.1.0"
+ },
+ "engines": {
+ "node": ">=6 <7 || >=8"
+ }
+ },
+ "node_modules/@oclif/errors/node_modules/jsonfile": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
+ "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==",
+ "optionalDependencies": {
+ "graceful-fs": "^4.1.6"
+ }
+ },
+ "node_modules/@oclif/errors/node_modules/universalify": {
+ "version": "0.1.2",
+ "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",
+ "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==",
+ "engines": {
+ "node": ">= 4.0.0"
+ }
+ },
+ "node_modules/@oclif/help": {
+ "version": "1.0.15",
+ "resolved": "https://registry.npmjs.org/@oclif/help/-/help-1.0.15.tgz",
+ "integrity": "sha512-Yt8UHoetk/XqohYX76DfdrUYLsPKMc5pgkzsZVHDyBSkLiGRzujVaGZdjr32ckVZU9q3a47IjhWxhip7Dz5W/g==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/config": "1.18.16",
+ "@oclif/errors": "1.3.6",
+ "chalk": "^4.1.2",
+ "indent-string": "^4.0.0",
+ "lodash": "^4.17.21",
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.0",
+ "widest-line": "^3.1.0",
+ "wrap-ansi": "^6.2.0"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/help/node_modules/@oclif/config": {
+ "version": "1.18.16",
+ "resolved": "https://registry.npmjs.org/@oclif/config/-/config-1.18.16.tgz",
+ "integrity": "sha512-VskIxVcN22qJzxRUq+raalq6Q3HUde7sokB7/xk5TqRZGEKRVbFeqdQBxDWwQeudiJEgcNiMvIFbMQ43dY37FA==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/errors": "^1.3.6",
+ "@oclif/parser": "^3.8.16",
+ "debug": "^4.3.4",
+ "globby": "^11.1.0",
+ "is-wsl": "^2.1.1",
+ "tslib": "^2.6.1"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/help/node_modules/wrap-ansi": {
+ "version": "6.2.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz",
+ "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@oclif/linewrap": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/@oclif/linewrap/-/linewrap-1.0.0.tgz",
+ "integrity": "sha512-Ups2dShK52xXa8w6iBWLgcjPJWjais6KPJQq3gQ/88AY6BXoTX+MIGFPrWQO1KLMiQfoTpcLnUwloN4brrVUHw=="
+ },
+ "node_modules/@oclif/parser": {
+ "version": "3.8.17",
+ "resolved": "https://registry.npmjs.org/@oclif/parser/-/parser-3.8.17.tgz",
+ "integrity": "sha512-l04iSd0xoh/16TGVpXb81Gg3z7tlQGrEup16BrVLsZBK6SEYpYHRJZnM32BwZrHI97ZSFfuSwVlzoo6HdsaK8A==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "dependencies": {
+ "@oclif/errors": "^1.3.6",
+ "@oclif/linewrap": "^1.0.0",
+ "chalk": "^4.1.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/@oclif/plugin-help": {
+ "version": "5.2.20",
+ "resolved": "https://registry.npmjs.org/@oclif/plugin-help/-/plugin-help-5.2.20.tgz",
+ "integrity": "sha512-u+GXX/KAGL9S10LxAwNUaWdzbEBARJ92ogmM7g3gDVud2HioCmvWQCDohNRVZ9GYV9oKwZ/M8xwd6a1d95rEKQ==",
+ "dependencies": {
+ "@oclif/core": "^2.15.0"
+ },
+ "engines": {
+ "node": ">=12.0.0"
+ }
+ },
+ "node_modules/@oclif/plugin-help/node_modules/@oclif/core": {
+ "version": "2.16.0",
+ "resolved": "https://registry.npmjs.org/@oclif/core/-/core-2.16.0.tgz",
+ "integrity": "sha512-dL6atBH0zCZl1A1IXCKJgLPrM/wR7K+Wi401E/IvqsK8m2iCHW+0TEOGrans/cuN3oTW+uxIyJFHJ8Im0k4qBw==",
+ "dependencies": {
+ "@types/cli-progress": "^3.11.0",
+ "ansi-escapes": "^4.3.2",
+ "ansi-styles": "^4.3.0",
+ "cardinal": "^2.1.1",
+ "chalk": "^4.1.2",
+ "clean-stack": "^3.0.1",
+ "cli-progress": "^3.12.0",
+ "debug": "^4.3.4",
+ "ejs": "^3.1.8",
+ "get-package-type": "^0.1.0",
+ "globby": "^11.1.0",
+ "hyperlinker": "^1.0.0",
+ "indent-string": "^4.0.0",
+ "is-wsl": "^2.2.0",
+ "js-yaml": "^3.14.1",
+ "natural-orderby": "^2.0.3",
+ "object-treeify": "^1.1.33",
+ "password-prompt": "^1.1.2",
+ "slice-ansi": "^4.0.0",
+ "string-width": "^4.2.3",
+ "strip-ansi": "^6.0.1",
+ "supports-color": "^8.1.1",
+ "supports-hyperlinks": "^2.2.0",
+ "ts-node": "^10.9.1",
+ "tslib": "^2.5.0",
+ "widest-line": "^3.1.0",
+ "wordwrap": "^1.0.0",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=14.0.0"
+ }
+ },
+ "node_modules/@oclif/plugin-help/node_modules/argparse": {
+ "version": "1.0.10",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
+ "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
+ "dependencies": {
+ "sprintf-js": "~1.0.2"
+ }
+ },
+ "node_modules/@oclif/plugin-help/node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@oclif/plugin-help/node_modules/js-yaml": {
+ "version": "3.14.1",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
+ "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
+ "dependencies": {
+ "argparse": "^1.0.7",
+ "esprima": "^4.0.0"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/@oclif/screen": {
+ "version": "3.0.8",
+ "resolved": "https://registry.npmjs.org/@oclif/screen/-/screen-3.0.8.tgz",
+ "integrity": "sha512-yx6KAqlt3TAHBduS2fMQtJDL2ufIHnDRArrJEOoTTuizxqmjLT+psGYOHpmMl3gvQpFJ11Hs76guUUktzAF9Bg==",
+ "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
+ "engines": {
+ "node": ">=12.0.0"
+ }
+ },
+ "node_modules/@redocly/ajv": {
+ "version": "8.11.2",
+ "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.2.tgz",
+ "integrity": "sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==",
+ "dependencies": {
+ "fast-deep-equal": "^3.1.1",
+ "json-schema-traverse": "^1.0.0",
+ "require-from-string": "^2.0.2",
+ "uri-js-replace": "^1.0.1"
+ },
+ "funding": {
+ "type": "github",
+ "url": "https://github.com/sponsors/epoberezkin"
+ }
+ },
+ "node_modules/@redocly/cli": {
+ "version": "1.25.11",
+ "resolved": "https://registry.npmjs.org/@redocly/cli/-/cli-1.25.11.tgz",
+ "integrity": "sha512-dttBsmLnnbTlJCTa+s7Sy+qtXDq692n7Ru3nUUIHp9XdCbhXIHWhpc8uAl+GmR4MGbVe8ohATl3J+zX3aFy82A==",
+ "license": "MIT",
+ "dependencies": {
+ "@redocly/openapi-core": "1.25.11",
+ "abort-controller": "^3.0.0",
+ "chokidar": "^3.5.1",
+ "colorette": "^1.2.0",
+ "core-js": "^3.32.1",
+ "form-data": "^4.0.0",
+ "get-port-please": "^3.0.1",
+ "glob": "^7.1.6",
+ "handlebars": "^4.7.6",
+ "mobx": "^6.0.4",
+ "node-fetch": "^2.6.1",
+ "pluralize": "^8.0.0",
+ "react": "^17.0.0 || ^18.2.0",
+ "react-dom": "^17.0.0 || ^18.2.0",
+ "redoc": "~2.2.0",
+ "semver": "^7.5.2",
+ "simple-websocket": "^9.0.0",
+ "styled-components": "^6.0.7",
+ "yargs": "17.0.1"
+ },
+ "bin": {
+ "openapi": "bin/cli.js",
+ "redocly": "bin/cli.js"
+ },
+ "engines": {
+ "node": ">=14.19.0",
+ "npm": ">=7.0.0"
+ }
+ },
+ "node_modules/@redocly/config": {
+ "version": "0.16.0",
+ "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.16.0.tgz",
+ "integrity": "sha512-t9jnODbUcuANRSl/K4L9nb12V+U5acIHnVSl26NWrtSdDZVtoqUXk2yGFPZzohYf62cCfEQUT8ouJ3bhPfpnJg=="
+ },
+ "node_modules/@redocly/openapi-core": {
+ "version": "1.25.11",
+ "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.25.11.tgz",
+ "integrity": "sha512-bH+a8izQz4fnKROKoX3bEU8sQ9rjvEIZOqU6qTmxlhOJ0NsKa5e+LmU18SV0oFeg5YhWQhhEDihXkvKJ1wMMNQ==",
+ "dependencies": {
+ "@redocly/ajv": "^8.11.2",
+ "@redocly/config": "^0.16.0",
+ "colorette": "^1.2.0",
+ "https-proxy-agent": "^7.0.4",
+ "js-levenshtein": "^1.1.6",
+ "js-yaml": "^4.1.0",
+ "lodash.isequal": "^4.5.0",
+ "minimatch": "^5.0.1",
+ "node-fetch": "^2.6.1",
+ "pluralize": "^8.0.0",
+ "yaml-ast-parser": "0.0.43"
+ },
+ "engines": {
+ "node": ">=14.19.0",
+ "npm": ">=7.0.0"
+ }
+ },
+ "node_modules/@redocly/openapi-core/node_modules/brace-expansion": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
+ "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
+ "dependencies": {
+ "balanced-match": "^1.0.0"
+ }
+ },
+ "node_modules/@redocly/openapi-core/node_modules/minimatch": {
+ "version": "5.1.6",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz",
+ "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==",
+ "dependencies": {
+ "brace-expansion": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/@stoplight/ordered-object-literal": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/@stoplight/ordered-object-literal/-/ordered-object-literal-1.0.5.tgz",
+ "integrity": "sha512-COTiuCU5bgMUtbIFBuyyh2/yVVzlr5Om0v5utQDgBCuQUOPgU1DwoffkTfg4UBQOvByi5foF4w4T+H9CoRe5wg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@stoplight/types": {
+ "version": "14.1.1",
+ "resolved": "https://registry.npmjs.org/@stoplight/types/-/types-14.1.1.tgz",
+ "integrity": "sha512-/kjtr+0t0tjKr+heVfviO9FrU/uGLc+QNX3fHJc19xsCNYqU7lVhaXxDmEID9BZTjG+/r9pK9xP/xU02XGg65g==",
+ "dependencies": {
+ "@types/json-schema": "^7.0.4",
+ "utility-types": "^3.10.0"
+ },
+ "engines": {
+ "node": "^12.20 || >=14.13"
+ }
+ },
+ "node_modules/@stoplight/yaml": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/@stoplight/yaml/-/yaml-4.3.0.tgz",
+ "integrity": "sha512-JZlVFE6/dYpP9tQmV0/ADfn32L9uFarHWxfcRhReKUnljz1ZiUM5zpX+PH8h5CJs6lao3TuFqnPm9IJJCEkE2w==",
+ "dependencies": {
+ "@stoplight/ordered-object-literal": "^1.0.5",
+ "@stoplight/types": "^14.1.1",
+ "@stoplight/yaml-ast-parser": "0.0.50",
+ "tslib": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=10.8"
+ }
+ },
+ "node_modules/@stoplight/yaml-ast-parser": {
+ "version": "0.0.50",
+ "resolved": "https://registry.npmjs.org/@stoplight/yaml-ast-parser/-/yaml-ast-parser-0.0.50.tgz",
+ "integrity": "sha512-Pb6M8TDO9DtSVla9yXSTAxmo9GVEouq5P40DWXdOie69bXogZTkgvopCq+yEvTMA0F6PEvdJmbtTV3ccIp11VQ=="
+ },
+ "node_modules/@tsconfig/node10": {
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.11.tgz",
+ "integrity": "sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw=="
+ },
+ "node_modules/@tsconfig/node12": {
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz",
+ "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag=="
+ },
+ "node_modules/@tsconfig/node14": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz",
+ "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow=="
+ },
+ "node_modules/@tsconfig/node16": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz",
+ "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA=="
+ },
+ "node_modules/@types/cli-progress": {
+ "version": "3.11.6",
+ "resolved": "https://registry.npmjs.org/@types/cli-progress/-/cli-progress-3.11.6.tgz",
+ "integrity": "sha512-cE3+jb9WRlu+uOSAugewNpITJDt1VF8dHOopPO4IABFc3SXYL5WE/+PTz/FCdZRRfIujiWW3n3aMbv1eIGVRWA==",
+ "dependencies": {
+ "@types/node": "*"
+ }
+ },
+ "node_modules/@types/json-schema": {
+ "version": "7.0.15",
+ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
+ "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="
+ },
+ "node_modules/@types/node": {
+ "version": "22.8.1",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-22.8.1.tgz",
+ "integrity": "sha512-k6Gi8Yyo8EtrNtkHXutUu2corfDf9su95VYVP10aGYMMROM6SAItZi0w1XszA6RtWTHSVp5OeFof37w0IEqCQg==",
+ "dependencies": {
+ "undici-types": "~6.19.8"
+ }
+ },
+ "node_modules/@types/stylis": {
+ "version": "4.2.5",
+ "resolved": "https://registry.npmjs.org/@types/stylis/-/stylis-4.2.5.tgz",
+ "integrity": "sha512-1Xve+NMN7FWjY14vLoY5tL3BVEQ/n42YLwaqJIPYhotZ9uBHt87VceMwWQpzmdEt2TNXIorIFG+YeCUUW7RInw=="
+ },
+ "node_modules/abort-controller": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz",
+ "integrity": "sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==",
+ "dependencies": {
+ "event-target-shim": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=6.5"
+ }
+ },
+ "node_modules/acorn": {
+ "version": "8.14.0",
+ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.0.tgz",
+ "integrity": "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA==",
+ "bin": {
+ "acorn": "bin/acorn"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/acorn-walk": {
+ "version": "8.3.4",
+ "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz",
+ "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==",
+ "dependencies": {
+ "acorn": "^8.11.0"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/agent-base": {
+ "version": "7.1.1",
+ "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.1.tgz",
+ "integrity": "sha512-H0TSyFNDMomMNJQBn8wFV5YC/2eJ+VXECwOadZJT554xP6cODZHPX3H9QMQECxvrgiSOP1pHjy1sMWQVYJOUOA==",
+ "dependencies": {
+ "debug": "^4.3.4"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/ansi-escapes": {
+ "version": "4.3.2",
+ "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz",
+ "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==",
+ "dependencies": {
+ "type-fest": "^0.21.3"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/ansicolors": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/ansicolors/-/ansicolors-0.3.2.tgz",
+ "integrity": "sha512-QXu7BPrP29VllRxH8GwB7x5iX5qWKAAMLqKQGWTeLWVlNHNOpVMJ91dsxQAIWXpjuW5wqvxu3Jd/nRjrJ+0pqg=="
+ },
+ "node_modules/anymatch": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz",
+ "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==",
+ "dependencies": {
+ "normalize-path": "^3.0.0",
+ "picomatch": "^2.0.4"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/arg": {
+ "version": "4.1.3",
+ "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz",
+ "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA=="
+ },
+ "node_modules/argparse": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+ },
+ "node_modules/array-buffer-byte-length": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz",
+ "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==",
+ "dependencies": {
+ "call-bind": "^1.0.5",
+ "is-array-buffer": "^3.0.4"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/array-union": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz",
+ "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/array.prototype.filter": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/array.prototype.filter/-/array.prototype.filter-1.0.4.tgz",
+ "integrity": "sha512-r+mCJ7zXgXElgR4IRC+fkvNCeoaavWBs6EdCso5Tbcf+iEMKzBU/His60lt34WEZ9vlb8wDkZvQGcVI5GwkfoQ==",
+ "peer": true,
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "define-properties": "^1.2.1",
+ "es-abstract": "^1.23.2",
+ "es-array-method-boxes-properly": "^1.0.0",
+ "es-object-atoms": "^1.0.0",
+ "is-string": "^1.0.7"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/array.prototype.flat": {
+ "version": "1.3.2",
+ "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.2.tgz",
+ "integrity": "sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==",
+ "peer": true,
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "define-properties": "^1.2.0",
+ "es-abstract": "^1.22.1",
+ "es-shim-unscopables": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/arraybuffer.prototype.slice": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz",
+ "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==",
+ "dependencies": {
+ "array-buffer-byte-length": "^1.0.1",
+ "call-bind": "^1.0.5",
+ "define-properties": "^1.2.1",
+ "es-abstract": "^1.22.3",
+ "es-errors": "^1.2.1",
+ "get-intrinsic": "^1.2.3",
+ "is-array-buffer": "^3.0.4",
+ "is-shared-array-buffer": "^1.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/astral-regex": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz",
+ "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/async": {
+ "version": "3.2.6",
+ "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz",
+ "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA=="
+ },
+ "node_modules/async-mutex": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/async-mutex/-/async-mutex-0.4.1.tgz",
+ "integrity": "sha512-WfoBo4E/TbCX1G95XTjbWTE3X2XLG0m1Xbv2cwOtuPdyH9CZvnaA5nCt1ucjaKEgW2A5IF71hxrRhr83Je5xjA==",
+ "dependencies": {
+ "tslib": "^2.4.0"
+ }
+ },
+ "node_modules/asynckit": {
+ "version": "0.4.0",
+ "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
+ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q=="
+ },
+ "node_modules/at-least-node": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
+ "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==",
+ "engines": {
+ "node": ">= 4.0.0"
+ }
+ },
+ "node_modules/available-typed-arrays": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz",
+ "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==",
+ "dependencies": {
+ "possible-typed-array-names": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/axios": {
+ "version": "1.7.7",
+ "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz",
+ "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==",
+ "dependencies": {
+ "follow-redirects": "^1.15.6",
+ "form-data": "^4.0.0",
+ "proxy-from-env": "^1.1.0"
+ }
+ },
+ "node_modules/balanced-match": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
+ "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="
+ },
+ "node_modules/binary-extensions": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz",
+ "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==",
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/boolbase": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz",
+ "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==",
+ "peer": true
+ },
+ "node_modules/brace-expansion": {
+ "version": "1.1.11",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
+ "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+ "dependencies": {
+ "balanced-match": "^1.0.0",
+ "concat-map": "0.0.1"
+ }
+ },
+ "node_modules/braces": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
+ "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
+ "dependencies": {
+ "fill-range": "^7.1.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/bump-cli": {
+ "version": "2.8.4",
+ "resolved": "https://registry.npmjs.org/bump-cli/-/bump-cli-2.8.4.tgz",
+ "integrity": "sha512-FwcsaY1jmCtwXkuIhkPxGLysLrxCJKnl54PHutb7N4FIuO9Hq8Xjn1giEfO3ZK8UGVZ9DiAb11H9ypFP6WNnhQ==",
+ "dependencies": {
+ "@apidevtools/json-schema-ref-parser": "^9.0.7",
+ "@asyncapi/specs": "^5.1.0",
+ "@clack/prompts": "^0.6.3",
+ "@oclif/command": "^1.8.36",
+ "@oclif/config": "^1.18.17",
+ "@oclif/core": "1.20.4",
+ "@oclif/plugin-help": "^5.1.10",
+ "@stoplight/yaml": "^4.2.3",
+ "async-mutex": "^0.4.0",
+ "axios": "^1.6.4",
+ "debug": "^4.3.1",
+ "jsonpath": "^1.1.1",
+ "mergician": "^1.0.3",
+ "oas-schemas": "git+https://git@github.com/OAI/OpenAPI-Specification.git#0f9d3ec7c033fef184ec54e1ffc201b2d61ce023",
+ "tslib": "^2.3.0"
+ },
+ "bin": {
+ "bump": "bin/run"
+ },
+ "engines": {
+ "node": ">=16.0.0"
+ }
+ },
+ "node_modules/call-bind": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz",
+ "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==",
+ "dependencies": {
+ "es-define-property": "^1.0.0",
+ "es-errors": "^1.3.0",
+ "function-bind": "^1.1.2",
+ "get-intrinsic": "^1.2.4",
+ "set-function-length": "^1.2.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/call-me-maybe": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz",
+ "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ=="
+ },
+ "node_modules/camelize": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/camelize/-/camelize-1.0.1.tgz",
+ "integrity": "sha512-dU+Tx2fsypxTgtLoE36npi3UqcjSSMNYfkqgmoEhtZrraP5VWq0K7FkWVTYa8eMPtnU/G2txVsfdCJTn9uzpuQ==",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/cardinal": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/cardinal/-/cardinal-2.1.1.tgz",
+ "integrity": "sha512-JSr5eOgoEymtYHBjNWyjrMqet9Am2miJhlfKNdqLp6zoeAh0KN5dRAcxlecj5mAJrmQomgiOBj35xHLrFjqBpw==",
+ "dependencies": {
+ "ansicolors": "~0.3.2",
+ "redeyed": "~2.1.0"
+ },
+ "bin": {
+ "cdl": "bin/cdl.js"
+ }
+ },
+ "node_modules/chalk": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+ "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
+ "dependencies": {
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
+ }
+ },
+ "node_modules/chalk/node_modules/supports-color": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+ "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/cheerio": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0.tgz",
+ "integrity": "sha512-quS9HgjQpdaXOvsZz82Oz7uxtXiy6UIsIQcpBj7HRw2M63Skasm9qlDocAM7jNuaxdhpPU7c4kJN+gA5MCu4ww==",
+ "peer": true,
+ "dependencies": {
+ "cheerio-select": "^2.1.0",
+ "dom-serializer": "^2.0.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.1.0",
+ "encoding-sniffer": "^0.2.0",
+ "htmlparser2": "^9.1.0",
+ "parse5": "^7.1.2",
+ "parse5-htmlparser2-tree-adapter": "^7.0.0",
+ "parse5-parser-stream": "^7.1.2",
+ "undici": "^6.19.5",
+ "whatwg-mimetype": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=18.17"
+ },
+ "funding": {
+ "url": "https://github.com/cheeriojs/cheerio?sponsor=1"
+ }
+ },
+ "node_modules/cheerio-select": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz",
+ "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==",
+ "peer": true,
+ "dependencies": {
+ "boolbase": "^1.0.0",
+ "css-select": "^5.1.0",
+ "css-what": "^6.1.0",
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.0.1"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
+ }
+ },
+ "node_modules/chokidar": {
+ "version": "3.6.0",
+ "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz",
+ "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==",
+ "dependencies": {
+ "anymatch": "~3.1.2",
+ "braces": "~3.0.2",
+ "glob-parent": "~5.1.2",
+ "is-binary-path": "~2.1.0",
+ "is-glob": "~4.0.1",
+ "normalize-path": "~3.0.0",
+ "readdirp": "~3.6.0"
+ },
+ "engines": {
+ "node": ">= 8.10.0"
+ },
+ "funding": {
+ "url": "https://paulmillr.com/funding/"
+ },
+ "optionalDependencies": {
+ "fsevents": "~2.3.2"
+ }
+ },
+ "node_modules/classnames": {
+ "version": "2.5.1",
+ "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.5.1.tgz",
+ "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow=="
+ },
+ "node_modules/clean-stack": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-3.0.1.tgz",
+ "integrity": "sha512-lR9wNiMRcVQjSB3a7xXGLuz4cr4wJuuXlaAEbRutGowQTmlp7R72/DOgN21e8jdwblMWl9UOJMJXarX94pzKdg==",
+ "dependencies": {
+ "escape-string-regexp": "4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/cli-progress": {
+ "version": "3.12.0",
+ "resolved": "https://registry.npmjs.org/cli-progress/-/cli-progress-3.12.0.tgz",
+ "integrity": "sha512-tRkV3HJ1ASwm19THiiLIXLO7Im7wlTuKnvkYaTkyoAPefqjNg7W7DHKUlGRxy9vxDvbyCYQkQozvptuMkGCg8A==",
+ "dependencies": {
+ "string-width": "^4.2.3"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/cliui": {
+ "version": "7.0.4",
+ "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz",
+ "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==",
+ "dependencies": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.0",
+ "wrap-ansi": "^7.0.0"
+ }
+ },
+ "node_modules/clsx": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz",
+ "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "node_modules/colorette": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz",
+ "integrity": "sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g=="
+ },
+ "node_modules/combined-stream": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
+ "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
+ "dependencies": {
+ "delayed-stream": "~1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/commander": {
+ "version": "2.20.3",
+ "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz",
+ "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==",
+ "peer": true
+ },
+ "node_modules/concat-map": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
+ "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="
+ },
+ "node_modules/core-js": {
+ "version": "3.39.0",
+ "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.39.0.tgz",
+ "integrity": "sha512-raM0ew0/jJUqkJ0E6e8UDtl+y/7ktFivgWvqw8dNSQeNWoSDLvQ1H/RN3aPXB9tBd4/FhyR4RDPGhsNIMsAn7g==",
+ "hasInstallScript": true,
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/core-js"
+ }
+ },
+ "node_modules/create-require": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",
+ "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ=="
+ },
+ "node_modules/cross-spawn": {
+ "version": "7.0.3",
+ "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
+ "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
+ "dependencies": {
+ "path-key": "^3.1.0",
+ "shebang-command": "^2.0.0",
+ "which": "^2.0.1"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/css-color-keywords": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/css-color-keywords/-/css-color-keywords-1.0.0.tgz",
+ "integrity": "sha512-FyyrDHZKEjXDpNJYvVsV960FiqQyXc/LlYmsxl2BcdMb2WPx0OGRVgTg55rPSyLSNMqP52R9r8geSp7apN3Ofg==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/css-select": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.1.0.tgz",
+ "integrity": "sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg==",
+ "peer": true,
+ "dependencies": {
+ "boolbase": "^1.0.0",
+ "css-what": "^6.1.0",
+ "domhandler": "^5.0.2",
+ "domutils": "^3.0.1",
+ "nth-check": "^2.0.1"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
+ }
+ },
+ "node_modules/css-to-react-native": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/css-to-react-native/-/css-to-react-native-3.2.0.tgz",
+ "integrity": "sha512-e8RKaLXMOFii+02mOlqwjbD00KSEKqblnpO9e++1aXS1fPQOpS1YoqdVHBqPjHNoxeF2mimzVqawm2KCbEdtHQ==",
+ "dependencies": {
+ "camelize": "^1.0.0",
+ "css-color-keywords": "^1.0.0",
+ "postcss-value-parser": "^4.0.2"
+ }
+ },
+ "node_modules/css-what": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.1.0.tgz",
+ "integrity": "sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==",
+ "peer": true,
+ "engines": {
+ "node": ">= 6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
+ }
+ },
+ "node_modules/csstype": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz",
+ "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="
+ },
+ "node_modules/data-view-buffer": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz",
+ "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==",
+ "dependencies": {
+ "call-bind": "^1.0.6",
+ "es-errors": "^1.3.0",
+ "is-data-view": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/data-view-byte-length": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz",
+ "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "es-errors": "^1.3.0",
+ "is-data-view": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/data-view-byte-offset": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz",
+ "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==",
+ "dependencies": {
+ "call-bind": "^1.0.6",
+ "es-errors": "^1.3.0",
+ "is-data-view": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/debug": {
+ "version": "4.3.7",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz",
+ "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==",
+ "dependencies": {
+ "ms": "^2.1.3"
+ },
+ "engines": {
+ "node": ">=6.0"
+ },
+ "peerDependenciesMeta": {
+ "supports-color": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/decko": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/decko/-/decko-1.2.0.tgz",
+ "integrity": "sha512-m8FnyHXV1QX+S1cl+KPFDIl6NMkxtKsy6+U/aYyjrOqWMuwAwYWu7ePqrsUHtDR5Y8Yk2pi/KIDSgF+vT4cPOQ=="
+ },
+ "node_modules/deep-is": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz",
+ "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ=="
+ },
+ "node_modules/define-data-property": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz",
+ "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==",
+ "dependencies": {
+ "es-define-property": "^1.0.0",
+ "es-errors": "^1.3.0",
+ "gopd": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/define-properties": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz",
+ "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==",
+ "dependencies": {
+ "define-data-property": "^1.0.1",
+ "has-property-descriptors": "^1.0.0",
+ "object-keys": "^1.1.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/delayed-stream": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
+ "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==",
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/diff": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz",
+ "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==",
+ "engines": {
+ "node": ">=0.3.1"
+ }
+ },
+ "node_modules/dir-glob": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz",
+ "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==",
+ "dependencies": {
+ "path-type": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/discontinuous-range": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/discontinuous-range/-/discontinuous-range-1.0.0.tgz",
+ "integrity": "sha512-c68LpLbO+7kP/b1Hr1qs8/BJ09F5khZGTxqxZuhzxpmwJKOgRFHJWIb9/KmqnqHhLdO55aOxFH/EGBvUQbL/RQ==",
+ "peer": true
+ },
+ "node_modules/dom-serializer": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz",
+ "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==",
+ "peer": true,
+ "dependencies": {
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.2",
+ "entities": "^4.2.0"
+ },
+ "funding": {
+ "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1"
+ }
+ },
+ "node_modules/domelementtype": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz",
+ "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/fb55"
+ }
+ ],
+ "peer": true
+ },
+ "node_modules/domhandler": {
+ "version": "5.0.3",
+ "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz",
+ "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==",
+ "peer": true,
+ "dependencies": {
+ "domelementtype": "^2.3.0"
+ },
+ "engines": {
+ "node": ">= 4"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/domhandler?sponsor=1"
+ }
+ },
+ "node_modules/dompurify": {
+ "version": "3.1.7",
+ "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-3.1.7.tgz",
+ "integrity": "sha512-VaTstWtsneJY8xzy7DekmYWEOZcmzIe3Qb3zPd4STve1OBTa+e+WmS1ITQec1fZYXI3HCsOZZiSMpG6oxoWMWQ=="
+ },
+ "node_modules/domutils": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.1.0.tgz",
+ "integrity": "sha512-H78uMmQtI2AhgDJjWeQmHwJJ2bLPD3GMmO7Zja/ZZh84wkm+4ut+IUnUdRa8uCGX88DiVx1j6FRe1XfxEgjEZA==",
+ "peer": true,
+ "dependencies": {
+ "dom-serializer": "^2.0.0",
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/domutils?sponsor=1"
+ }
+ },
+ "node_modules/ejs": {
+ "version": "3.1.10",
+ "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz",
+ "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==",
+ "dependencies": {
+ "jake": "^10.8.5"
+ },
+ "bin": {
+ "ejs": "bin/cli.js"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
+ },
+ "node_modules/encoding-sniffer": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/encoding-sniffer/-/encoding-sniffer-0.2.0.tgz",
+ "integrity": "sha512-ju7Wq1kg04I3HtiYIOrUrdfdDvkyO9s5XM8QAj/bN61Yo/Vb4vgJxy5vi4Yxk01gWHbrofpPtpxM8bKger9jhg==",
+ "peer": true,
+ "dependencies": {
+ "iconv-lite": "^0.6.3",
+ "whatwg-encoding": "^3.1.1"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/encoding-sniffer?sponsor=1"
+ }
+ },
+ "node_modules/entities": {
+ "version": "4.5.0",
+ "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz",
+ "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==",
+ "peer": true,
+ "engines": {
+ "node": ">=0.12"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/entities?sponsor=1"
+ }
+ },
+ "node_modules/enzyme": {
+ "version": "3.11.0",
+ "resolved": "https://registry.npmjs.org/enzyme/-/enzyme-3.11.0.tgz",
+ "integrity": "sha512-Dw8/Gs4vRjxY6/6i9wU0V+utmQO9kvh9XLnz3LIudviOnVYDEe2ec+0k+NQoMamn1VrjKgCUOWj5jG/5M5M0Qw==",
+ "peer": true,
+ "dependencies": {
+ "array.prototype.flat": "^1.2.3",
+ "cheerio": "^1.0.0-rc.3",
+ "enzyme-shallow-equal": "^1.0.1",
+ "function.prototype.name": "^1.1.2",
+ "has": "^1.0.3",
+ "html-element-map": "^1.2.0",
+ "is-boolean-object": "^1.0.1",
+ "is-callable": "^1.1.5",
+ "is-number-object": "^1.0.4",
+ "is-regex": "^1.0.5",
+ "is-string": "^1.0.5",
+ "is-subset": "^0.1.1",
+ "lodash.escape": "^4.0.1",
+ "lodash.isequal": "^4.5.0",
+ "object-inspect": "^1.7.0",
+ "object-is": "^1.0.2",
+ "object.assign": "^4.1.0",
+ "object.entries": "^1.1.1",
+ "object.values": "^1.1.1",
+ "raf": "^3.4.1",
+ "rst-selector-parser": "^2.2.3",
+ "string.prototype.trim": "^1.2.1"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/enzyme-shallow-equal": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/enzyme-shallow-equal/-/enzyme-shallow-equal-1.0.7.tgz",
+ "integrity": "sha512-/um0GFqUXnpM9SvKtje+9Tjoz3f1fpBC3eXRFrNs8kpYn69JljciYP7KZTqM/YQbUY9KUjvKB4jo/q+L6WGGvg==",
+ "dependencies": {
+ "hasown": "^2.0.0",
+ "object-is": "^1.1.5"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/es-abstract": {
+ "version": "1.23.3",
+ "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz",
+ "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==",
+ "dependencies": {
+ "array-buffer-byte-length": "^1.0.1",
+ "arraybuffer.prototype.slice": "^1.0.3",
+ "available-typed-arrays": "^1.0.7",
+ "call-bind": "^1.0.7",
+ "data-view-buffer": "^1.0.1",
+ "data-view-byte-length": "^1.0.1",
+ "data-view-byte-offset": "^1.0.0",
+ "es-define-property": "^1.0.0",
+ "es-errors": "^1.3.0",
+ "es-object-atoms": "^1.0.0",
+ "es-set-tostringtag": "^2.0.3",
+ "es-to-primitive": "^1.2.1",
+ "function.prototype.name": "^1.1.6",
+ "get-intrinsic": "^1.2.4",
+ "get-symbol-description": "^1.0.2",
+ "globalthis": "^1.0.3",
+ "gopd": "^1.0.1",
+ "has-property-descriptors": "^1.0.2",
+ "has-proto": "^1.0.3",
+ "has-symbols": "^1.0.3",
+ "hasown": "^2.0.2",
+ "internal-slot": "^1.0.7",
+ "is-array-buffer": "^3.0.4",
+ "is-callable": "^1.2.7",
+ "is-data-view": "^1.0.1",
+ "is-negative-zero": "^2.0.3",
+ "is-regex": "^1.1.4",
+ "is-shared-array-buffer": "^1.0.3",
+ "is-string": "^1.0.7",
+ "is-typed-array": "^1.1.13",
+ "is-weakref": "^1.0.2",
+ "object-inspect": "^1.13.1",
+ "object-keys": "^1.1.1",
+ "object.assign": "^4.1.5",
+ "regexp.prototype.flags": "^1.5.2",
+ "safe-array-concat": "^1.1.2",
+ "safe-regex-test": "^1.0.3",
+ "string.prototype.trim": "^1.2.9",
+ "string.prototype.trimend": "^1.0.8",
+ "string.prototype.trimstart": "^1.0.8",
+ "typed-array-buffer": "^1.0.2",
+ "typed-array-byte-length": "^1.0.1",
+ "typed-array-byte-offset": "^1.0.2",
+ "typed-array-length": "^1.0.6",
+ "unbox-primitive": "^1.0.2",
+ "which-typed-array": "^1.1.15"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/es-array-method-boxes-properly": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/es-array-method-boxes-properly/-/es-array-method-boxes-properly-1.0.0.tgz",
+ "integrity": "sha512-wd6JXUmyHmt8T5a2xreUwKcGPq6f1f+WwIJkijUqiGcJz1qqnZgP6XIK+QyIWU5lT7imeNxUll48bziG+TSYcA==",
+ "peer": true
+ },
+ "node_modules/es-define-property": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz",
+ "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==",
+ "dependencies": {
+ "get-intrinsic": "^1.2.4"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/es-errors": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz",
+ "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==",
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/es-object-atoms": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz",
+ "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==",
+ "dependencies": {
+ "es-errors": "^1.3.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/es-set-tostringtag": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz",
+ "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==",
+ "dependencies": {
+ "get-intrinsic": "^1.2.4",
+ "has-tostringtag": "^1.0.2",
+ "hasown": "^2.0.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/es-shim-unscopables": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.2.tgz",
+ "integrity": "sha512-J3yBRXCzDu4ULnQwxyToo/OjdMx6akgVC7K6few0a7F/0wLtmKKN7I73AH5T2836UuXRqN7Qg+IIUw/+YJksRw==",
+ "peer": true,
+ "dependencies": {
+ "hasown": "^2.0.0"
+ }
+ },
+ "node_modules/es-to-primitive": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz",
+ "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==",
+ "dependencies": {
+ "is-callable": "^1.1.4",
+ "is-date-object": "^1.0.1",
+ "is-symbol": "^1.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/es6-promise": {
+ "version": "3.3.1",
+ "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-3.3.1.tgz",
+ "integrity": "sha512-SOp9Phqvqn7jtEUxPWdWfWoLmyt2VaJ6MpvP9Comy1MceMXqE6bxvaTu4iaxpYYPzhny28Lc+M87/c2cPK6lDg=="
+ },
+ "node_modules/escalade": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz",
+ "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/escape-string-regexp": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
+ "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/escodegen": {
+ "version": "1.14.3",
+ "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.14.3.tgz",
+ "integrity": "sha512-qFcX0XJkdg+PB3xjZZG/wKSuT1PnQWx57+TVSjIMmILd2yC/6ByYElPwJnslDsuWuSAp4AwJGumarAAmJch5Kw==",
+ "dependencies": {
+ "esprima": "^4.0.1",
+ "estraverse": "^4.2.0",
+ "esutils": "^2.0.2",
+ "optionator": "^0.8.1"
+ },
+ "bin": {
+ "escodegen": "bin/escodegen.js",
+ "esgenerate": "bin/esgenerate.js"
+ },
+ "engines": {
+ "node": ">=4.0"
+ },
+ "optionalDependencies": {
+ "source-map": "~0.6.1"
+ }
+ },
+ "node_modules/escodegen/node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/esprima": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.2.2.tgz",
+ "integrity": "sha512-+JpPZam9w5DuJ3Q67SqsMGtiHKENSMRVoxvArfJZK01/BfLEObtZ6orJa/MtoGNR/rfMgp5837T41PAmTwAv/A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/estraverse": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz",
+ "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==",
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/esutils": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz",
+ "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/event-target-shim": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz",
+ "integrity": "sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/eventemitter3": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.1.tgz",
+ "integrity": "sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA=="
+ },
+ "node_modules/fast-deep-equal": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
+ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
+ },
+ "node_modules/fast-glob": {
+ "version": "3.3.2",
+ "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz",
+ "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==",
+ "dependencies": {
+ "@nodelib/fs.stat": "^2.0.2",
+ "@nodelib/fs.walk": "^1.2.3",
+ "glob-parent": "^5.1.2",
+ "merge2": "^1.3.0",
+ "micromatch": "^4.0.4"
+ },
+ "engines": {
+ "node": ">=8.6.0"
+ }
+ },
+ "node_modules/fast-levenshtein": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz",
+ "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="
+ },
+ "node_modules/fast-safe-stringify": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz",
+ "integrity": "sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA=="
+ },
+ "node_modules/fastq": {
+ "version": "1.17.1",
+ "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz",
+ "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==",
+ "dependencies": {
+ "reusify": "^1.0.4"
+ }
+ },
+ "node_modules/filelist": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.4.tgz",
+ "integrity": "sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==",
+ "dependencies": {
+ "minimatch": "^5.0.1"
+ }
+ },
+ "node_modules/filelist/node_modules/brace-expansion": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
+ "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
+ "dependencies": {
+ "balanced-match": "^1.0.0"
+ }
+ },
+ "node_modules/filelist/node_modules/minimatch": {
+ "version": "5.1.6",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz",
+ "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==",
+ "dependencies": {
+ "brace-expansion": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/fill-range": {
+ "version": "7.1.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
+ "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
+ "dependencies": {
+ "to-regex-range": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/follow-redirects": {
+ "version": "1.15.9",
+ "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.9.tgz",
+ "integrity": "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==",
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://github.com/sponsors/RubenVerborgh"
+ }
+ ],
+ "engines": {
+ "node": ">=4.0"
+ },
+ "peerDependenciesMeta": {
+ "debug": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/for-each": {
+ "version": "0.3.3",
+ "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz",
+ "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==",
+ "dependencies": {
+ "is-callable": "^1.1.3"
+ }
+ },
+ "node_modules/foreach": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.6.tgz",
+ "integrity": "sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg=="
+ },
+ "node_modules/form-data": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.1.tgz",
+ "integrity": "sha512-tzN8e4TX8+kkxGPK8D5u0FNmjPUjw3lwC9lSLxxoB/+GtsJG91CO8bSWy73APlgAZzZbXEYZJuxjkHH2w+Ezhw==",
+ "dependencies": {
+ "asynckit": "^0.4.0",
+ "combined-stream": "^1.0.8",
+ "mime-types": "^2.1.12"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/fs-extra": {
+ "version": "9.1.0",
+ "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
+ "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
+ "dependencies": {
+ "at-least-node": "^1.0.0",
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^6.0.1",
+ "universalify": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/fs.realpath": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
+ "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw=="
+ },
+ "node_modules/fsevents": {
+ "version": "2.3.3",
+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
+ "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
+ "hasInstallScript": true,
+ "optional": true,
+ "os": [
+ "darwin"
+ ],
+ "engines": {
+ "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
+ }
+ },
+ "node_modules/function-bind": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz",
+ "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/function.prototype.name": {
+ "version": "1.1.6",
+ "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.6.tgz",
+ "integrity": "sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==",
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "define-properties": "^1.2.0",
+ "es-abstract": "^1.22.1",
+ "functions-have-names": "^1.2.3"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/functions-have-names": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz",
+ "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/get-caller-file": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
+ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
+ "engines": {
+ "node": "6.* || 8.* || >= 10.*"
+ }
+ },
+ "node_modules/get-intrinsic": {
+ "version": "1.2.4",
+ "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz",
+ "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==",
+ "dependencies": {
+ "es-errors": "^1.3.0",
+ "function-bind": "^1.1.2",
+ "has-proto": "^1.0.1",
+ "has-symbols": "^1.0.3",
+ "hasown": "^2.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/get-package-type": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz",
+ "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==",
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/get-port-please": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/get-port-please/-/get-port-please-3.1.2.tgz",
+ "integrity": "sha512-Gxc29eLs1fbn6LQ4jSU4vXjlwyZhF5HsGuMAa7gqBP4Rw4yxxltyDUuF5MBclFzDTXO+ACchGQoeela4DSfzdQ=="
+ },
+ "node_modules/get-symbol-description": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz",
+ "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==",
+ "dependencies": {
+ "call-bind": "^1.0.5",
+ "es-errors": "^1.3.0",
+ "get-intrinsic": "^1.2.4"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/glob": {
+ "version": "7.2.3",
+ "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz",
+ "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==",
+ "deprecated": "Glob versions prior to v9 are no longer supported",
+ "dependencies": {
+ "fs.realpath": "^1.0.0",
+ "inflight": "^1.0.4",
+ "inherits": "2",
+ "minimatch": "^3.1.1",
+ "once": "^1.3.0",
+ "path-is-absolute": "^1.0.0"
+ },
+ "engines": {
+ "node": "*"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/glob-parent": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+ "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
+ "dependencies": {
+ "is-glob": "^4.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/globalthis": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz",
+ "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==",
+ "dependencies": {
+ "define-properties": "^1.2.1",
+ "gopd": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/globby": {
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz",
+ "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==",
+ "dependencies": {
+ "array-union": "^2.1.0",
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.9",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/gopd": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz",
+ "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==",
+ "dependencies": {
+ "get-intrinsic": "^1.1.3"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/graceful-fs": {
+ "version": "4.2.11",
+ "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
+ "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ=="
+ },
+ "node_modules/handlebars": {
+ "version": "4.7.8",
+ "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz",
+ "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==",
+ "dependencies": {
+ "minimist": "^1.2.5",
+ "neo-async": "^2.6.2",
+ "source-map": "^0.6.1",
+ "wordwrap": "^1.0.0"
+ },
+ "bin": {
+ "handlebars": "bin/handlebars"
+ },
+ "engines": {
+ "node": ">=0.4.7"
+ },
+ "optionalDependencies": {
+ "uglify-js": "^3.1.4"
+ }
+ },
+ "node_modules/has": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/has/-/has-1.0.4.tgz",
+ "integrity": "sha512-qdSAmqLF6209RFj4VVItywPMbm3vWylknmB3nvNiUIs72xAimcM8nVYxYr7ncvZq5qzk9MKIZR8ijqD/1QuYjQ==",
+ "engines": {
+ "node": ">= 0.4.0"
+ }
+ },
+ "node_modules/has-bigints": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz",
+ "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/has-flag": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
+ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/has-property-descriptors": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz",
+ "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==",
+ "dependencies": {
+ "es-define-property": "^1.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/has-proto": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz",
+ "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==",
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/has-symbols": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz",
+ "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==",
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/has-tostringtag": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz",
+ "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==",
+ "dependencies": {
+ "has-symbols": "^1.0.3"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/hasown": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz",
+ "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==",
+ "dependencies": {
+ "function-bind": "^1.1.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/html-element-map": {
+ "version": "1.3.1",
+ "resolved": "https://registry.npmjs.org/html-element-map/-/html-element-map-1.3.1.tgz",
+ "integrity": "sha512-6XMlxrAFX4UEEGxctfFnmrFaaZFNf9i5fNuV5wZ3WWQ4FVaNP1aX1LkX9j2mfEx1NpjeE/rL3nmgEn23GdFmrg==",
+ "peer": true,
+ "dependencies": {
+ "array.prototype.filter": "^1.0.0",
+ "call-bind": "^1.0.2"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/htmlparser2": {
+ "version": "9.1.0",
+ "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-9.1.0.tgz",
+ "integrity": "sha512-5zfg6mHUoaer/97TxnGpxmbR7zJtPwIYFMZ/H5ucTlPZhKvtum05yiPK3Mgai3a0DyVxv7qYqoweaEd2nrYQzQ==",
+ "funding": [
+ "https://github.com/fb55/htmlparser2?sponsor=1",
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/fb55"
+ }
+ ],
+ "peer": true,
+ "dependencies": {
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.1.0",
+ "entities": "^4.5.0"
+ }
+ },
+ "node_modules/http2-client": {
+ "version": "1.3.5",
+ "resolved": "https://registry.npmjs.org/http2-client/-/http2-client-1.3.5.tgz",
+ "integrity": "sha512-EC2utToWl4RKfs5zd36Mxq7nzHHBuomZboI0yYL6Y0RmBgT7Sgkq4rQ0ezFTYoIsSs7Tm9SJe+o2FcAg6GBhGA=="
+ },
+ "node_modules/https-proxy-agent": {
+ "version": "7.0.5",
+ "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz",
+ "integrity": "sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==",
+ "dependencies": {
+ "agent-base": "^7.0.2",
+ "debug": "4"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/hyperlinker": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/hyperlinker/-/hyperlinker-1.0.0.tgz",
+ "integrity": "sha512-Ty8UblRWFEcfSuIaajM34LdPXIhbs1ajEX/BBPv24J+enSVaEVY63xQ6lTO9VRYS5LAoghIG0IDJ+p+IPzKUQQ==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/iconv-lite": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
+ "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==",
+ "peer": true,
+ "dependencies": {
+ "safer-buffer": ">= 2.1.2 < 3.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/ignore": {
+ "version": "5.3.2",
+ "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz",
+ "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==",
+ "engines": {
+ "node": ">= 4"
+ }
+ },
+ "node_modules/indent-string": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz",
+ "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/inflight": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
+ "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==",
+ "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.",
+ "dependencies": {
+ "once": "^1.3.0",
+ "wrappy": "1"
+ }
+ },
+ "node_modules/inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
+ },
+ "node_modules/internal-slot": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz",
+ "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==",
+ "dependencies": {
+ "es-errors": "^1.3.0",
+ "hasown": "^2.0.0",
+ "side-channel": "^1.0.4"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/is-array-buffer": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz",
+ "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==",
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "get-intrinsic": "^1.2.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-bigint": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz",
+ "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==",
+ "dependencies": {
+ "has-bigints": "^1.0.1"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-binary-path": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz",
+ "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==",
+ "dependencies": {
+ "binary-extensions": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-boolean-object": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz",
+ "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==",
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "has-tostringtag": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-callable": {
+ "version": "1.2.7",
+ "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz",
+ "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==",
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-data-view": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz",
+ "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==",
+ "dependencies": {
+ "is-typed-array": "^1.1.13"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-date-object": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz",
+ "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==",
+ "dependencies": {
+ "has-tostringtag": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-docker": {
+ "version": "2.2.1",
+ "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz",
+ "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==",
+ "bin": {
+ "is-docker": "cli.js"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-glob": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+ "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+ "dependencies": {
+ "is-extglob": "^2.1.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-negative-zero": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz",
+ "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==",
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/is-number-object": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz",
+ "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==",
+ "dependencies": {
+ "has-tostringtag": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-regex": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz",
+ "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==",
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "has-tostringtag": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-shared-array-buffer": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz",
+ "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==",
+ "dependencies": {
+ "call-bind": "^1.0.7"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-string": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz",
+ "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==",
+ "dependencies": {
+ "has-tostringtag": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-subset": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/is-subset/-/is-subset-0.1.1.tgz",
+ "integrity": "sha512-6Ybun0IkarhmEqxXCNw/C0bna6Zb/TkfUX9UbwJtK6ObwAVCxmAP308WWTHviM/zAqXk05cdhYsUsZeGQh99iw==",
+ "peer": true
+ },
+ "node_modules/is-symbol": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz",
+ "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==",
+ "dependencies": {
+ "has-symbols": "^1.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-typed-array": {
+ "version": "1.1.13",
+ "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz",
+ "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==",
+ "dependencies": {
+ "which-typed-array": "^1.1.14"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-weakref": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz",
+ "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==",
+ "dependencies": {
+ "call-bind": "^1.0.2"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-wsl": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz",
+ "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==",
+ "dependencies": {
+ "is-docker": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/isarray": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz",
+ "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw=="
+ },
+ "node_modules/isexe": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
+ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="
+ },
+ "node_modules/jake": {
+ "version": "10.9.2",
+ "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.2.tgz",
+ "integrity": "sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA==",
+ "dependencies": {
+ "async": "^3.2.3",
+ "chalk": "^4.0.2",
+ "filelist": "^1.0.4",
+ "minimatch": "^3.1.2"
+ },
+ "bin": {
+ "jake": "bin/cli.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/js-levenshtein": {
+ "version": "1.1.6",
+ "resolved": "https://registry.npmjs.org/js-levenshtein/-/js-levenshtein-1.1.6.tgz",
+ "integrity": "sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/js-tokens": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ=="
+ },
+ "node_modules/js-yaml": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+ "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+ "dependencies": {
+ "argparse": "^2.0.1"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/json-pointer": {
+ "version": "0.6.2",
+ "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.2.tgz",
+ "integrity": "sha512-vLWcKbOaXlO+jvRy4qNd+TI1QUPZzfJj1tpJ3vAXDych5XJf93ftpUKe5pKCrzyIIwgBJcOcCVRUfqQP25afBw==",
+ "dependencies": {
+ "foreach": "^2.0.4"
+ }
+ },
+ "node_modules/json-schema-traverse": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
+ "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="
+ },
+ "node_modules/jsonfile": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
+ "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
+ "dependencies": {
+ "universalify": "^2.0.0"
+ },
+ "optionalDependencies": {
+ "graceful-fs": "^4.1.6"
+ }
+ },
+ "node_modules/jsonpath": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/jsonpath/-/jsonpath-1.1.1.tgz",
+ "integrity": "sha512-l6Cg7jRpixfbgoWgkrl77dgEj8RPvND0wMH6TwQmi9Qs4TFfS9u5cUFnbeKTwj5ga5Y3BTGGNI28k117LJ009w==",
+ "dependencies": {
+ "esprima": "1.2.2",
+ "static-eval": "2.0.2",
+ "underscore": "1.12.1"
+ }
+ },
+ "node_modules/levn": {
+ "version": "0.3.0",
+ "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz",
+ "integrity": "sha512-0OO4y2iOHix2W6ujICbKIaEQXvFQHue65vUG3pb5EUomzPI90z9hsA1VsO/dbIIpC53J8gxM9Q4Oho0jrCM/yA==",
+ "dependencies": {
+ "prelude-ls": "~1.1.2",
+ "type-check": "~0.3.2"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/lodash": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+ },
+ "node_modules/lodash.escape": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/lodash.escape/-/lodash.escape-4.0.1.tgz",
+ "integrity": "sha512-nXEOnb/jK9g0DYMr1/Xvq6l5xMD7GDG55+GSYIYmS0G4tBk/hURD4JR9WCavs04t33WmJx9kCyp9vJ+mr4BOUw==",
+ "peer": true
+ },
+ "node_modules/lodash.flattendeep": {
+ "version": "4.4.0",
+ "resolved": "https://registry.npmjs.org/lodash.flattendeep/-/lodash.flattendeep-4.4.0.tgz",
+ "integrity": "sha512-uHaJFihxmJcEX3kT4I23ABqKKalJ/zDrDg0lsFtc1h+3uw49SIJ5beyhx5ExVRti3AvKoOJngIj7xz3oylPdWQ==",
+ "peer": true
+ },
+ "node_modules/lodash.isequal": {
+ "version": "4.5.0",
+ "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
+ "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ=="
+ },
+ "node_modules/loose-envify": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz",
+ "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==",
+ "dependencies": {
+ "js-tokens": "^3.0.0 || ^4.0.0"
+ },
+ "bin": {
+ "loose-envify": "cli.js"
+ }
+ },
+ "node_modules/lunr": {
+ "version": "2.3.9",
+ "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
+ "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow=="
+ },
+ "node_modules/make-error": {
+ "version": "1.3.6",
+ "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
+ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw=="
+ },
+ "node_modules/mark.js": {
+ "version": "8.11.1",
+ "resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz",
+ "integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ=="
+ },
+ "node_modules/marked": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz",
+ "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==",
+ "bin": {
+ "marked": "bin/marked.js"
+ },
+ "engines": {
+ "node": ">= 12"
+ }
+ },
+ "node_modules/merge2": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
+ "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/mergician": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/mergician/-/mergician-1.1.0.tgz",
+ "integrity": "sha512-FXbxzU6BBhGkV8XtUr8Sk015ZRaAALviit8Lle6OEgd1udX8wlu6tBeUMLGQGdz1MfHpAVNNQkXowyDnJuhXpA==",
+ "engines": {
+ "node": ">=10.0.0"
+ }
+ },
+ "node_modules/micromatch": {
+ "version": "4.0.8",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
+ "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
+ "dependencies": {
+ "braces": "^3.0.3",
+ "picomatch": "^2.3.1"
+ },
+ "engines": {
+ "node": ">=8.6"
+ }
+ },
+ "node_modules/mime-db": {
+ "version": "1.52.0",
+ "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz",
+ "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/mime-types": {
+ "version": "2.1.35",
+ "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz",
+ "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==",
+ "dependencies": {
+ "mime-db": "1.52.0"
+ },
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/minimatch": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+ "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
+ "dependencies": {
+ "brace-expansion": "^1.1.7"
+ },
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/minimist": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+ "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/mobx": {
+ "version": "6.13.5",
+ "resolved": "https://registry.npmjs.org/mobx/-/mobx-6.13.5.tgz",
+ "integrity": "sha512-/HTWzW2s8J1Gqt+WmUj5Y0mddZk+LInejADc79NJadrWla3rHzmRHki/mnEUH1AvOmbNTZ1BRbKxr8DSgfdjMA==",
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/mobx"
+ }
+ },
+ "node_modules/mobx-react": {
+ "version": "9.1.1",
+ "resolved": "https://registry.npmjs.org/mobx-react/-/mobx-react-9.1.1.tgz",
+ "integrity": "sha512-gVV7AdSrAAxqXOJ2bAbGa5TkPqvITSzaPiiEkzpW4rRsMhSec7C2NBCJYILADHKp2tzOAIETGRsIY0UaCV5aEw==",
+ "dependencies": {
+ "mobx-react-lite": "^4.0.7"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/mobx"
+ },
+ "peerDependencies": {
+ "mobx": "^6.9.0",
+ "react": "^16.8.0 || ^17 || ^18"
+ },
+ "peerDependenciesMeta": {
+ "react-dom": {
+ "optional": true
+ },
+ "react-native": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/mobx-react-lite": {
+ "version": "4.0.7",
+ "resolved": "https://registry.npmjs.org/mobx-react-lite/-/mobx-react-lite-4.0.7.tgz",
+ "integrity": "sha512-RjwdseshK9Mg8On5tyJZHtGD+J78ZnCnRaxeQDSiciKVQDUbfZcXhmld0VMxAwvcTnPEHZySGGewm467Fcpreg==",
+ "dependencies": {
+ "use-sync-external-store": "^1.2.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/mobx"
+ },
+ "peerDependencies": {
+ "mobx": "^6.9.0",
+ "react": "^16.8.0 || ^17 || ^18"
+ },
+ "peerDependenciesMeta": {
+ "react-dom": {
+ "optional": true
+ },
+ "react-native": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/moo": {
+ "version": "0.5.2",
+ "resolved": "https://registry.npmjs.org/moo/-/moo-0.5.2.tgz",
+ "integrity": "sha512-iSAJLHYKnX41mKcJKjqvnAN9sf0LMDTXDEvFv+ffuRR9a1MIuXLjMNL6EsnDHSkKLTWNqQQ5uo61P4EbU4NU+Q==",
+ "peer": true
+ },
+ "node_modules/ms": {
+ "version": "2.1.3",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
+ "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
+ },
+ "node_modules/nanoid": {
+ "version": "3.3.7",
+ "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz",
+ "integrity": "sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/ai"
+ }
+ ],
+ "bin": {
+ "nanoid": "bin/nanoid.cjs"
+ },
+ "engines": {
+ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1"
+ }
+ },
+ "node_modules/natural-orderby": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/natural-orderby/-/natural-orderby-2.0.3.tgz",
+ "integrity": "sha512-p7KTHxU0CUrcOXe62Zfrb5Z13nLvPhSWR/so3kFulUQU0sgUll2Z0LwpsLN351eOOD+hRGu/F1g+6xDfPeD++Q==",
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/nearley": {
+ "version": "2.20.1",
+ "resolved": "https://registry.npmjs.org/nearley/-/nearley-2.20.1.tgz",
+ "integrity": "sha512-+Mc8UaAebFzgV+KpI5n7DasuuQCHA89dmwm7JXw3TV43ukfNQ9DnBH3Mdb2g/I4Fdxc26pwimBWvjIw0UAILSQ==",
+ "peer": true,
+ "dependencies": {
+ "commander": "^2.19.0",
+ "moo": "^0.5.0",
+ "railroad-diagrams": "^1.0.0",
+ "randexp": "0.4.6"
+ },
+ "bin": {
+ "nearley-railroad": "bin/nearley-railroad.js",
+ "nearley-test": "bin/nearley-test.js",
+ "nearley-unparse": "bin/nearley-unparse.js",
+ "nearleyc": "bin/nearleyc.js"
+ },
+ "funding": {
+ "type": "individual",
+ "url": "https://nearley.js.org/#give-to-nearley"
+ }
+ },
+ "node_modules/neo-async": {
+ "version": "2.6.2",
+ "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz",
+ "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw=="
+ },
+ "node_modules/node-fetch": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz",
+ "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==",
+ "dependencies": {
+ "whatwg-url": "^5.0.0"
+ },
+ "engines": {
+ "node": "4.x || >=6.0.0"
+ },
+ "peerDependencies": {
+ "encoding": "^0.1.0"
+ },
+ "peerDependenciesMeta": {
+ "encoding": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/node-fetch-h2": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/node-fetch-h2/-/node-fetch-h2-2.3.0.tgz",
+ "integrity": "sha512-ofRW94Ab0T4AOh5Fk8t0h8OBWrmjb0SSB20xh1H8YnPV9EJ+f5AMoYSUQ2zgJ4Iq2HAK0I2l5/Nequ8YzFS3Hg==",
+ "dependencies": {
+ "http2-client": "^1.2.5"
+ },
+ "engines": {
+ "node": "4.x || >=6.0.0"
+ }
+ },
+ "node_modules/node-readfiles": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/node-readfiles/-/node-readfiles-0.2.0.tgz",
+ "integrity": "sha512-SU00ZarexNlE4Rjdm83vglt5Y9yiQ+XI1XpflWlb7q7UTN1JUItm69xMeiQCTxtTfnzt+83T8Cx+vI2ED++VDA==",
+ "dependencies": {
+ "es6-promise": "^3.2.1"
+ }
+ },
+ "node_modules/normalize-path": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz",
+ "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/nth-check": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz",
+ "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==",
+ "peer": true,
+ "dependencies": {
+ "boolbase": "^1.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/nth-check?sponsor=1"
+ }
+ },
+ "node_modules/oas-kit-common": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/oas-kit-common/-/oas-kit-common-1.0.8.tgz",
+ "integrity": "sha512-pJTS2+T0oGIwgjGpw7sIRU8RQMcUoKCDWFLdBqKB2BNmGpbBMH2sdqAaOXUg8OzonZHU0L7vfJu1mJFEiYDWOQ==",
+ "dependencies": {
+ "fast-safe-stringify": "^2.0.7"
+ }
+ },
+ "node_modules/oas-linter": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/oas-linter/-/oas-linter-3.2.2.tgz",
+ "integrity": "sha512-KEGjPDVoU5K6swgo9hJVA/qYGlwfbFx+Kg2QB/kd7rzV5N8N5Mg6PlsoCMohVnQmo+pzJap/F610qTodKzecGQ==",
+ "dependencies": {
+ "@exodus/schemasafe": "^1.0.0-rc.2",
+ "should": "^13.2.1",
+ "yaml": "^1.10.0"
+ },
+ "funding": {
+ "url": "https://github.com/Mermade/oas-kit?sponsor=1"
+ }
+ },
+ "node_modules/oas-resolver": {
+ "version": "2.5.6",
+ "resolved": "https://registry.npmjs.org/oas-resolver/-/oas-resolver-2.5.6.tgz",
+ "integrity": "sha512-Yx5PWQNZomfEhPPOphFbZKi9W93CocQj18NlD2Pa4GWZzdZpSJvYwoiuurRI7m3SpcChrnO08hkuQDL3FGsVFQ==",
+ "dependencies": {
+ "node-fetch-h2": "^2.3.0",
+ "oas-kit-common": "^1.0.8",
+ "reftools": "^1.1.9",
+ "yaml": "^1.10.0",
+ "yargs": "^17.0.1"
+ },
+ "bin": {
+ "resolve": "resolve.js"
+ },
+ "funding": {
+ "url": "https://github.com/Mermade/oas-kit?sponsor=1"
+ }
+ },
+ "node_modules/oas-schema-walker": {
+ "version": "1.1.5",
+ "resolved": "https://registry.npmjs.org/oas-schema-walker/-/oas-schema-walker-1.1.5.tgz",
+ "integrity": "sha512-2yucenq1a9YPmeNExoUa9Qwrt9RFkjqaMAA1X+U7sbb0AqBeTIdMHky9SQQ6iN94bO5NW0W4TRYXerG+BdAvAQ==",
+ "funding": {
+ "url": "https://github.com/Mermade/oas-kit?sponsor=1"
+ }
+ },
+ "node_modules/oas-schemas": {
+ "version": "2.0.0",
+ "resolved": "git+https://git@github.com/OAI/OpenAPI-Specification.git#0f9d3ec7c033fef184ec54e1ffc201b2d61ce023",
+ "integrity": "sha512-B0izsjJFhgA/KCQExAt7cfLyw42KD+r3NE7hKbkmGSqoe3gb57eMUXTlN4MwEicFR86Gno+h3OSnRcHfUlVubQ=="
+ },
+ "node_modules/oas-validator": {
+ "version": "5.0.8",
+ "resolved": "https://registry.npmjs.org/oas-validator/-/oas-validator-5.0.8.tgz",
+ "integrity": "sha512-cu20/HE5N5HKqVygs3dt94eYJfBi0TsZvPVXDhbXQHiEityDN+RROTleefoKRKKJ9dFAF2JBkDHgvWj0sjKGmw==",
+ "dependencies": {
+ "call-me-maybe": "^1.0.1",
+ "oas-kit-common": "^1.0.8",
+ "oas-linter": "^3.2.2",
+ "oas-resolver": "^2.5.6",
+ "oas-schema-walker": "^1.1.5",
+ "reftools": "^1.1.9",
+ "should": "^13.2.1",
+ "yaml": "^1.10.0"
+ },
+ "funding": {
+ "url": "https://github.com/Mermade/oas-kit?sponsor=1"
+ }
+ },
+ "node_modules/object-assign": {
+ "version": "4.1.1",
+ "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz",
+ "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/object-inspect": {
+ "version": "1.13.2",
+ "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.2.tgz",
+ "integrity": "sha512-IRZSRuzJiynemAXPYtPe5BoI/RESNYR7TYm50MC5Mqbd3Jmw5y790sErYw3V6SryFJD64b74qQQs9wn5Bg/k3g==",
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/object-is": {
+ "version": "1.1.6",
+ "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz",
+ "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "define-properties": "^1.2.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/object-keys": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz",
+ "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==",
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/object-treeify": {
+ "version": "1.1.33",
+ "resolved": "https://registry.npmjs.org/object-treeify/-/object-treeify-1.1.33.tgz",
+ "integrity": "sha512-EFVjAYfzWqWsBMRHPMAXLCDIJnpMhdWAqR7xG6M6a2cs6PMFpl/+Z20w9zDW4vkxOFfddegBKq9Rehd0bxWE7A==",
+ "engines": {
+ "node": ">= 10"
+ }
+ },
+ "node_modules/object.assign": {
+ "version": "4.1.5",
+ "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz",
+ "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==",
+ "dependencies": {
+ "call-bind": "^1.0.5",
+ "define-properties": "^1.2.1",
+ "has-symbols": "^1.0.3",
+ "object-keys": "^1.1.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/object.entries": {
+ "version": "1.1.8",
+ "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.8.tgz",
+ "integrity": "sha512-cmopxi8VwRIAw/fkijJohSfpef5PdN0pMQJN6VC/ZKvn0LIknWD8KtgY6KlQdEc4tIjcQ3HxSMmnvtzIscdaYQ==",
+ "peer": true,
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "define-properties": "^1.2.1",
+ "es-object-atoms": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/object.values": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz",
+ "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==",
+ "peer": true,
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "define-properties": "^1.2.1",
+ "es-object-atoms": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/once": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
+ "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
+ "dependencies": {
+ "wrappy": "1"
+ }
+ },
+ "node_modules/openapi-sampler": {
+ "version": "1.5.1",
+ "resolved": "https://registry.npmjs.org/openapi-sampler/-/openapi-sampler-1.5.1.tgz",
+ "integrity": "sha512-tIWIrZUKNAsbqf3bd9U1oH6JEXo8LNYuDlXw26By67EygpjT+ArFnsxxyTMjFWRfbqo5ozkvgSQDK69Gd8CddA==",
+ "dependencies": {
+ "@types/json-schema": "^7.0.7",
+ "json-pointer": "0.6.2"
+ }
+ },
+ "node_modules/optionator": {
+ "version": "0.8.3",
+ "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz",
+ "integrity": "sha512-+IW9pACdk3XWmmTXG8m3upGUJst5XRGzxMRjXzAuJ1XnIFNvfhjjIuYkDvysnPQ7qzqVzLt78BCruntqRhWQbA==",
+ "dependencies": {
+ "deep-is": "~0.1.3",
+ "fast-levenshtein": "~2.0.6",
+ "levn": "~0.3.0",
+ "prelude-ls": "~1.1.2",
+ "type-check": "~0.3.2",
+ "word-wrap": "~1.2.3"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/parse5": {
+ "version": "7.2.1",
+ "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.2.1.tgz",
+ "integrity": "sha512-BuBYQYlv1ckiPdQi/ohiivi9Sagc9JG+Ozs0r7b/0iK3sKmrb0b9FdWdBbOdx6hBCM/F9Ir82ofnBhtZOjCRPQ==",
+ "peer": true,
+ "dependencies": {
+ "entities": "^4.5.0"
+ },
+ "funding": {
+ "url": "https://github.com/inikulin/parse5?sponsor=1"
+ }
+ },
+ "node_modules/parse5-htmlparser2-tree-adapter": {
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz",
+ "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==",
+ "peer": true,
+ "dependencies": {
+ "domhandler": "^5.0.3",
+ "parse5": "^7.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/inikulin/parse5?sponsor=1"
+ }
+ },
+ "node_modules/parse5-parser-stream": {
+ "version": "7.1.2",
+ "resolved": "https://registry.npmjs.org/parse5-parser-stream/-/parse5-parser-stream-7.1.2.tgz",
+ "integrity": "sha512-JyeQc9iwFLn5TbvvqACIF/VXG6abODeB3Fwmv/TGdLk2LfbWkaySGY72at4+Ty7EkPZj854u4CrICqNk2qIbow==",
+ "peer": true,
+ "dependencies": {
+ "parse5": "^7.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/inikulin/parse5?sponsor=1"
+ }
+ },
+ "node_modules/password-prompt": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/password-prompt/-/password-prompt-1.1.3.tgz",
+ "integrity": "sha512-HkrjG2aJlvF0t2BMH0e2LB/EHf3Lcq3fNMzy4GYHcQblAvOl+QQji1Lx7WRBMqpVK8p+KR7bCg7oqAMXtdgqyw==",
+ "dependencies": {
+ "ansi-escapes": "^4.3.2",
+ "cross-spawn": "^7.0.3"
+ }
+ },
+ "node_modules/path-browserify": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz",
+ "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g=="
+ },
+ "node_modules/path-is-absolute": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
+ "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/path-key": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
+ "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/path-type": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz",
+ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/perfect-scrollbar": {
+ "version": "1.5.6",
+ "resolved": "https://registry.npmjs.org/perfect-scrollbar/-/perfect-scrollbar-1.5.6.tgz",
+ "integrity": "sha512-rixgxw3SxyJbCaSpo1n35A/fwI1r2rdwMKOTCg/AcG+xOEyZcE8UHVjpZMFCVImzsFoCZeJTT+M/rdEIQYO2nw=="
+ },
+ "node_modules/performance-now": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz",
+ "integrity": "sha512-7EAHlyLHI56VEIdK57uwHdHKIaAGbnXPiw0yWbarQZOKaKpvUIgW0jWRVLiatnM+XXlSwsanIBH/hzGMJulMow==",
+ "peer": true
+ },
+ "node_modules/picocolors": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz",
+ "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA=="
+ },
+ "node_modules/picomatch": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==",
+ "engines": {
+ "node": ">=8.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/jonschlinkert"
+ }
+ },
+ "node_modules/pluralize": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz",
+ "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/polished": {
+ "version": "4.3.1",
+ "resolved": "https://registry.npmjs.org/polished/-/polished-4.3.1.tgz",
+ "integrity": "sha512-OBatVyC/N7SCW/FaDHrSd+vn0o5cS855TOmYi4OkdWUMSJCET/xip//ch8xGUvtr3i44X9LVyWwQlRMTN3pwSA==",
+ "dependencies": {
+ "@babel/runtime": "^7.17.8"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/possible-typed-array-names": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz",
+ "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==",
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/postcss": {
+ "version": "8.4.38",
+ "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz",
+ "integrity": "sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==",
+ "funding": [
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/postcss/"
+ },
+ {
+ "type": "tidelift",
+ "url": "https://tidelift.com/funding/github/npm/postcss"
+ },
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/ai"
+ }
+ ],
+ "dependencies": {
+ "nanoid": "^3.3.7",
+ "picocolors": "^1.0.0",
+ "source-map-js": "^1.2.0"
+ },
+ "engines": {
+ "node": "^10 || ^12 || >=14"
+ }
+ },
+ "node_modules/postcss-value-parser": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz",
+ "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ=="
+ },
+ "node_modules/prelude-ls": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz",
+ "integrity": "sha512-ESF23V4SKG6lVSGZgYNpbsiaAkdab6ZgOxe52p7+Kid3W3u3bxR4Vfd/o21dmN7jSt0IwgZ4v5MUd26FEtXE9w==",
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/prismjs": {
+ "version": "1.29.0",
+ "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.29.0.tgz",
+ "integrity": "sha512-Kx/1w86q/epKcmte75LNrEoT+lX8pBpavuAbvJWRXar7Hz8jrtF+e3vY751p0R8H9HdArwaCTNDDzHg/ScJK1Q==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/prop-types": {
+ "version": "15.8.1",
+ "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz",
+ "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==",
+ "dependencies": {
+ "loose-envify": "^1.4.0",
+ "object-assign": "^4.1.1",
+ "react-is": "^16.13.1"
+ }
+ },
+ "node_modules/prop-types/node_modules/react-is": {
+ "version": "16.13.1",
+ "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz",
+ "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ=="
+ },
+ "node_modules/proxy-from-env": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz",
+ "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg=="
+ },
+ "node_modules/queue-microtask": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+ "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/raf": {
+ "version": "3.4.1",
+ "resolved": "https://registry.npmjs.org/raf/-/raf-3.4.1.tgz",
+ "integrity": "sha512-Sq4CW4QhwOHE8ucn6J34MqtZCeWFP2aQSmrlroYgqAV1PjStIhJXxYuTgUIfkEk7zTLjmIjLmU5q+fbD1NnOJA==",
+ "peer": true,
+ "dependencies": {
+ "performance-now": "^2.1.0"
+ }
+ },
+ "node_modules/railroad-diagrams": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/railroad-diagrams/-/railroad-diagrams-1.0.0.tgz",
+ "integrity": "sha512-cz93DjNeLY0idrCNOH6PviZGRN9GJhsdm9hpn1YCS879fj4W+x5IFJhhkRZcwVgMmFF7R82UA/7Oh+R8lLZg6A==",
+ "peer": true
+ },
+ "node_modules/randexp": {
+ "version": "0.4.6",
+ "resolved": "https://registry.npmjs.org/randexp/-/randexp-0.4.6.tgz",
+ "integrity": "sha512-80WNmd9DA0tmZrw9qQa62GPPWfuXJknrmVmLcxvq4uZBdYqb1wYoKTmnlGUchvVWe0XiLupYkBoXVOxz3C8DYQ==",
+ "peer": true,
+ "dependencies": {
+ "discontinuous-range": "1.0.0",
+ "ret": "~0.1.10"
+ },
+ "engines": {
+ "node": ">=0.12"
+ }
+ },
+ "node_modules/randombytes": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz",
+ "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==",
+ "dependencies": {
+ "safe-buffer": "^5.1.0"
+ }
+ },
+ "node_modules/react": {
+ "version": "18.3.1",
+ "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz",
+ "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==",
+ "dependencies": {
+ "loose-envify": "^1.1.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/react-dom": {
+ "version": "18.3.1",
+ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz",
+ "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==",
+ "dependencies": {
+ "loose-envify": "^1.1.0",
+ "scheduler": "^0.23.2"
+ },
+ "peerDependencies": {
+ "react": "^18.3.1"
+ }
+ },
+ "node_modules/react-is": {
+ "version": "18.3.1",
+ "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz",
+ "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg=="
+ },
+ "node_modules/react-shallow-renderer": {
+ "version": "16.15.0",
+ "resolved": "https://registry.npmjs.org/react-shallow-renderer/-/react-shallow-renderer-16.15.0.tgz",
+ "integrity": "sha512-oScf2FqQ9LFVQgA73vr86xl2NaOIX73rh+YFqcOp68CWj56tSfgtGKrEbyhCj0rSijyG9M1CYprTh39fBi5hzA==",
+ "dependencies": {
+ "object-assign": "^4.1.1",
+ "react-is": "^16.12.0 || ^17.0.0 || ^18.0.0"
+ },
+ "peerDependencies": {
+ "react": "^16.0.0 || ^17.0.0 || ^18.0.0"
+ }
+ },
+ "node_modules/react-tabs": {
+ "version": "6.0.2",
+ "resolved": "https://registry.npmjs.org/react-tabs/-/react-tabs-6.0.2.tgz",
+ "integrity": "sha512-aQXTKolnM28k3KguGDBSAbJvcowOQr23A+CUJdzJtOSDOtTwzEaJA+1U4KwhNL9+Obe+jFS7geuvA7ICQPXOnQ==",
+ "dependencies": {
+ "clsx": "^2.0.0",
+ "prop-types": "^15.5.0"
+ },
+ "peerDependencies": {
+ "react": "^18.0.0"
+ }
+ },
+ "node_modules/readable-stream": {
+ "version": "3.6.2",
+ "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz",
+ "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==",
+ "dependencies": {
+ "inherits": "^2.0.3",
+ "string_decoder": "^1.1.1",
+ "util-deprecate": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/readdirp": {
+ "version": "3.6.0",
+ "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz",
+ "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==",
+ "dependencies": {
+ "picomatch": "^2.2.1"
+ },
+ "engines": {
+ "node": ">=8.10.0"
+ }
+ },
+ "node_modules/redeyed": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/redeyed/-/redeyed-2.1.1.tgz",
+ "integrity": "sha512-FNpGGo1DycYAdnrKFxCMmKYgo/mILAqtRYbkdQD8Ep/Hk2PQ5+aEAEx+IU713RTDmuBaH0c8P5ZozurNu5ObRQ==",
+ "dependencies": {
+ "esprima": "~4.0.0"
+ }
+ },
+ "node_modules/redeyed/node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/redoc": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/redoc/-/redoc-2.2.0.tgz",
+ "integrity": "sha512-52rz/xJtpUBc3Y/GAkaX03czKhQXTxoU7WnkXNzRLuGwiGb/iEO4OgwcgQqtwHWrYNaZXTyqZ4MAVXpi/e1gAg==",
+ "dependencies": {
+ "@cfaester/enzyme-adapter-react-18": "^0.8.0",
+ "@redocly/openapi-core": "^1.4.0",
+ "classnames": "^2.3.2",
+ "decko": "^1.2.0",
+ "dompurify": "^3.0.6",
+ "eventemitter3": "^5.0.1",
+ "json-pointer": "^0.6.2",
+ "lunr": "^2.3.9",
+ "mark.js": "^8.11.1",
+ "marked": "^4.3.0",
+ "mobx-react": "^9.1.1",
+ "openapi-sampler": "^1.5.0",
+ "path-browserify": "^1.0.1",
+ "perfect-scrollbar": "^1.5.5",
+ "polished": "^4.2.2",
+ "prismjs": "^1.29.0",
+ "prop-types": "^15.8.1",
+ "react-tabs": "^6.0.2",
+ "slugify": "~1.4.7",
+ "stickyfill": "^1.1.1",
+ "swagger2openapi": "^7.0.8",
+ "url-template": "^2.0.8"
+ },
+ "engines": {
+ "node": ">=6.9",
+ "npm": ">=3.0.0"
+ },
+ "peerDependencies": {
+ "core-js": "^3.1.4",
+ "mobx": "^6.0.4",
+ "react": "^16.8.4 || ^17.0.0 || ^18.0.0",
+ "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0",
+ "styled-components": "^4.1.1 || ^5.1.1 || ^6.0.5"
+ }
+ },
+ "node_modules/reftools": {
+ "version": "1.1.9",
+ "resolved": "https://registry.npmjs.org/reftools/-/reftools-1.1.9.tgz",
+ "integrity": "sha512-OVede/NQE13xBQ+ob5CKd5KyeJYU2YInb1bmV4nRoOfquZPkAkxuOXicSe1PvqIuZZ4kD13sPKBbR7UFDmli6w==",
+ "funding": {
+ "url": "https://github.com/Mermade/oas-kit?sponsor=1"
+ }
+ },
+ "node_modules/regenerator-runtime": {
+ "version": "0.14.1",
+ "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.14.1.tgz",
+ "integrity": "sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw=="
+ },
+ "node_modules/regexp.prototype.flags": {
+ "version": "1.5.3",
+ "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.3.tgz",
+ "integrity": "sha512-vqlC04+RQoFalODCbCumG2xIOvapzVMHwsyIGM/SIE8fRhFFsXeH8/QQ+s0T0kDAhKc4k30s73/0ydkHQz6HlQ==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "define-properties": "^1.2.1",
+ "es-errors": "^1.3.0",
+ "set-function-name": "^2.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/require-directory": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
+ "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/require-from-string": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
+ "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/ret": {
+ "version": "0.1.15",
+ "resolved": "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz",
+ "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==",
+ "peer": true,
+ "engines": {
+ "node": ">=0.12"
+ }
+ },
+ "node_modules/reusify": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz",
+ "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==",
+ "engines": {
+ "iojs": ">=1.0.0",
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/rst-selector-parser": {
+ "version": "2.2.3",
+ "resolved": "https://registry.npmjs.org/rst-selector-parser/-/rst-selector-parser-2.2.3.tgz",
+ "integrity": "sha512-nDG1rZeP6oFTLN6yNDV/uiAvs1+FS/KlrEwh7+y7dpuApDBy6bI2HTBcc0/V8lv9OTqfyD34eF7au2pm8aBbhA==",
+ "peer": true,
+ "dependencies": {
+ "lodash.flattendeep": "^4.4.0",
+ "nearley": "^2.7.10"
+ }
+ },
+ "node_modules/run-parallel": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
+ "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "dependencies": {
+ "queue-microtask": "^1.2.2"
+ }
+ },
+ "node_modules/safe-array-concat": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz",
+ "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "get-intrinsic": "^1.2.4",
+ "has-symbols": "^1.0.3",
+ "isarray": "^2.0.5"
+ },
+ "engines": {
+ "node": ">=0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/safe-buffer": {
+ "version": "5.2.1",
+ "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
+ "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/safe-regex-test": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz",
+ "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==",
+ "dependencies": {
+ "call-bind": "^1.0.6",
+ "es-errors": "^1.3.0",
+ "is-regex": "^1.1.4"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/safer-buffer": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz",
+ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==",
+ "peer": true
+ },
+ "node_modules/scheduler": {
+ "version": "0.23.2",
+ "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.2.tgz",
+ "integrity": "sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==",
+ "dependencies": {
+ "loose-envify": "^1.1.0"
+ }
+ },
+ "node_modules/semver": {
+ "version": "7.6.3",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz",
+ "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==",
+ "bin": {
+ "semver": "bin/semver.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/set-function-length": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz",
+ "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==",
+ "dependencies": {
+ "define-data-property": "^1.1.4",
+ "es-errors": "^1.3.0",
+ "function-bind": "^1.1.2",
+ "get-intrinsic": "^1.2.4",
+ "gopd": "^1.0.1",
+ "has-property-descriptors": "^1.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/set-function-name": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz",
+ "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==",
+ "dependencies": {
+ "define-data-property": "^1.1.4",
+ "es-errors": "^1.3.0",
+ "functions-have-names": "^1.2.3",
+ "has-property-descriptors": "^1.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/shallowequal": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz",
+ "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ=="
+ },
+ "node_modules/shebang-command": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
+ "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
+ "dependencies": {
+ "shebang-regex": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/shebang-regex": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
+ "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/should": {
+ "version": "13.2.3",
+ "resolved": "https://registry.npmjs.org/should/-/should-13.2.3.tgz",
+ "integrity": "sha512-ggLesLtu2xp+ZxI+ysJTmNjh2U0TsC+rQ/pfED9bUZZ4DKefP27D+7YJVVTvKsmjLpIi9jAa7itwDGkDDmt1GQ==",
+ "dependencies": {
+ "should-equal": "^2.0.0",
+ "should-format": "^3.0.3",
+ "should-type": "^1.4.0",
+ "should-type-adaptors": "^1.0.1",
+ "should-util": "^1.0.0"
+ }
+ },
+ "node_modules/should-equal": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/should-equal/-/should-equal-2.0.0.tgz",
+ "integrity": "sha512-ZP36TMrK9euEuWQYBig9W55WPC7uo37qzAEmbjHz4gfyuXrEUgF8cUvQVO+w+d3OMfPvSRQJ22lSm8MQJ43LTA==",
+ "dependencies": {
+ "should-type": "^1.4.0"
+ }
+ },
+ "node_modules/should-format": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/should-format/-/should-format-3.0.3.tgz",
+ "integrity": "sha512-hZ58adtulAk0gKtua7QxevgUaXTTXxIi8t41L3zo9AHvjXO1/7sdLECuHeIN2SRtYXpNkmhoUP2pdeWgricQ+Q==",
+ "dependencies": {
+ "should-type": "^1.3.0",
+ "should-type-adaptors": "^1.0.1"
+ }
+ },
+ "node_modules/should-type": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/should-type/-/should-type-1.4.0.tgz",
+ "integrity": "sha512-MdAsTu3n25yDbIe1NeN69G4n6mUnJGtSJHygX3+oN0ZbO3DTiATnf7XnYJdGT42JCXurTb1JI0qOBR65shvhPQ=="
+ },
+ "node_modules/should-type-adaptors": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/should-type-adaptors/-/should-type-adaptors-1.1.0.tgz",
+ "integrity": "sha512-JA4hdoLnN+kebEp2Vs8eBe9g7uy0zbRo+RMcU0EsNy+R+k049Ki+N5tT5Jagst2g7EAja+euFuoXFCa8vIklfA==",
+ "dependencies": {
+ "should-type": "^1.3.0",
+ "should-util": "^1.0.0"
+ }
+ },
+ "node_modules/should-util": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/should-util/-/should-util-1.0.1.tgz",
+ "integrity": "sha512-oXF8tfxx5cDk8r2kYqlkUJzZpDBqVY/II2WhvU0n9Y3XYvAYRmeaf1PvvIvTgPnv4KJ+ES5M0PyDq5Jp+Ygy2g=="
+ },
+ "node_modules/side-channel": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz",
+ "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "es-errors": "^1.3.0",
+ "get-intrinsic": "^1.2.4",
+ "object-inspect": "^1.13.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/simple-websocket": {
+ "version": "9.1.0",
+ "resolved": "https://registry.npmjs.org/simple-websocket/-/simple-websocket-9.1.0.tgz",
+ "integrity": "sha512-8MJPnjRN6A8UCp1I+H/dSFyjwJhp6wta4hsVRhjf8w9qBHRzxYt14RaOcjvQnhD1N4yKOddEjflwMnQM4VtXjQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "dependencies": {
+ "debug": "^4.3.1",
+ "queue-microtask": "^1.2.2",
+ "randombytes": "^2.1.0",
+ "readable-stream": "^3.6.0",
+ "ws": "^7.4.2"
+ }
+ },
+ "node_modules/sisteransi": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg=="
+ },
+ "node_modules/slash": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
+ "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/slice-ansi": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz",
+ "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "astral-regex": "^2.0.0",
+ "is-fullwidth-code-point": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/slice-ansi?sponsor=1"
+ }
+ },
+ "node_modules/slugify": {
+ "version": "1.4.7",
+ "resolved": "https://registry.npmjs.org/slugify/-/slugify-1.4.7.tgz",
+ "integrity": "sha512-tf+h5W1IrjNm/9rKKj0JU2MDMruiopx0jjVA5zCdBtcGjfp0+c5rHw/zADLC3IeKlGHtVbHtpfzvYA0OYT+HKg==",
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/source-map": {
+ "version": "0.6.1",
+ "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+ "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/source-map-js": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz",
+ "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/sprintf-js": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
+ "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g=="
+ },
+ "node_modules/static-eval": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/static-eval/-/static-eval-2.0.2.tgz",
+ "integrity": "sha512-N/D219Hcr2bPjLxPiV+TQE++Tsmrady7TqAJugLy7Xk1EumfDWS/f5dtBbkRCGE7wKKXuYockQoj8Rm2/pVKyg==",
+ "dependencies": {
+ "escodegen": "^1.8.1"
+ }
+ },
+ "node_modules/stickyfill": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/stickyfill/-/stickyfill-1.1.1.tgz",
+ "integrity": "sha512-GCp7vHAfpao+Qh/3Flh9DXEJ/qSi0KJwJw6zYlZOtRYXWUIpMM6mC2rIep/dK8RQqwW0KxGJIllmjPIBOGN8AA=="
+ },
+ "node_modules/string_decoder": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz",
+ "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==",
+ "dependencies": {
+ "safe-buffer": "~5.2.0"
+ }
+ },
+ "node_modules/string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "dependencies": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/string.prototype.trim": {
+ "version": "1.2.9",
+ "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz",
+ "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "define-properties": "^1.2.1",
+ "es-abstract": "^1.23.0",
+ "es-object-atoms": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/string.prototype.trimend": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz",
+ "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "define-properties": "^1.2.1",
+ "es-object-atoms": "^1.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/string.prototype.trimstart": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz",
+ "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "define-properties": "^1.2.1",
+ "es-object-atoms": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "dependencies": {
+ "ansi-regex": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/styled-components": {
+ "version": "6.1.13",
+ "resolved": "https://registry.npmjs.org/styled-components/-/styled-components-6.1.13.tgz",
+ "integrity": "sha512-M0+N2xSnAtwcVAQeFEsGWFFxXDftHUD7XrKla06QbpUMmbmtFBMMTcKWvFXtWxuD5qQkB8iU5gk6QASlx2ZRMw==",
+ "dependencies": {
+ "@emotion/is-prop-valid": "1.2.2",
+ "@emotion/unitless": "0.8.1",
+ "@types/stylis": "4.2.5",
+ "css-to-react-native": "3.2.0",
+ "csstype": "3.1.3",
+ "postcss": "8.4.38",
+ "shallowequal": "1.1.0",
+ "stylis": "4.3.2",
+ "tslib": "2.6.2"
+ },
+ "engines": {
+ "node": ">= 16"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/styled-components"
+ },
+ "peerDependencies": {
+ "react": ">= 16.8.0",
+ "react-dom": ">= 16.8.0"
+ }
+ },
+ "node_modules/styled-components/node_modules/tslib": {
+ "version": "2.6.2",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz",
+ "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q=="
+ },
+ "node_modules/stylis": {
+ "version": "4.3.2",
+ "resolved": "https://registry.npmjs.org/stylis/-/stylis-4.3.2.tgz",
+ "integrity": "sha512-bhtUjWd/z6ltJiQwg0dUfxEJ+W+jdqQd8TbWLWyeIJHlnsqmGLRFFd8e5mA0AZi/zx90smXRlN66YMTcaSFifg=="
+ },
+ "node_modules/supports-color": {
+ "version": "8.1.1",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz",
+ "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/supports-color?sponsor=1"
+ }
+ },
+ "node_modules/supports-hyperlinks": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/supports-hyperlinks/-/supports-hyperlinks-2.3.0.tgz",
+ "integrity": "sha512-RpsAZlpWcDwOPQA22aCH4J0t7L8JmAvsCxfOSEwm7cQs3LshN36QaTkwd70DnBOXDWGssw2eUoc8CaRWT0XunA==",
+ "dependencies": {
+ "has-flag": "^4.0.0",
+ "supports-color": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/supports-hyperlinks/node_modules/supports-color": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+ "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/swagger2openapi": {
+ "version": "7.0.8",
+ "resolved": "https://registry.npmjs.org/swagger2openapi/-/swagger2openapi-7.0.8.tgz",
+ "integrity": "sha512-upi/0ZGkYgEcLeGieoz8gT74oWHA0E7JivX7aN9mAf+Tc7BQoRBvnIGHoPDw+f9TXTW4s6kGYCZJtauP6OYp7g==",
+ "dependencies": {
+ "call-me-maybe": "^1.0.1",
+ "node-fetch": "^2.6.1",
+ "node-fetch-h2": "^2.3.0",
+ "node-readfiles": "^0.2.0",
+ "oas-kit-common": "^1.0.8",
+ "oas-resolver": "^2.5.6",
+ "oas-schema-walker": "^1.1.5",
+ "oas-validator": "^5.0.8",
+ "reftools": "^1.1.9",
+ "yaml": "^1.10.0",
+ "yargs": "^17.0.1"
+ },
+ "bin": {
+ "boast": "boast.js",
+ "oas-validate": "oas-validate.js",
+ "swagger2openapi": "swagger2openapi.js"
+ },
+ "funding": {
+ "url": "https://github.com/Mermade/oas-kit?sponsor=1"
+ }
+ },
+ "node_modules/to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "dependencies": {
+ "is-number": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0"
+ }
+ },
+ "node_modules/tr46": {
+ "version": "0.0.3",
+ "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
+ "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw=="
+ },
+ "node_modules/ts-node": {
+ "version": "10.9.2",
+ "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
+ "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==",
+ "dependencies": {
+ "@cspotcode/source-map-support": "^0.8.0",
+ "@tsconfig/node10": "^1.0.7",
+ "@tsconfig/node12": "^1.0.7",
+ "@tsconfig/node14": "^1.0.0",
+ "@tsconfig/node16": "^1.0.2",
+ "acorn": "^8.4.1",
+ "acorn-walk": "^8.1.1",
+ "arg": "^4.1.0",
+ "create-require": "^1.1.0",
+ "diff": "^4.0.1",
+ "make-error": "^1.1.1",
+ "v8-compile-cache-lib": "^3.0.1",
+ "yn": "3.1.1"
+ },
+ "bin": {
+ "ts-node": "dist/bin.js",
+ "ts-node-cwd": "dist/bin-cwd.js",
+ "ts-node-esm": "dist/bin-esm.js",
+ "ts-node-script": "dist/bin-script.js",
+ "ts-node-transpile-only": "dist/bin-transpile.js",
+ "ts-script": "dist/bin-script-deprecated.js"
+ },
+ "peerDependencies": {
+ "@swc/core": ">=1.2.50",
+ "@swc/wasm": ">=1.2.50",
+ "@types/node": "*",
+ "typescript": ">=2.7"
+ },
+ "peerDependenciesMeta": {
+ "@swc/core": {
+ "optional": true
+ },
+ "@swc/wasm": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/tslib": {
+ "version": "2.8.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.0.tgz",
+ "integrity": "sha512-jWVzBLplnCmoaTr13V9dYbiQ99wvZRd0vNWaDRg+aVYRcjDF3nDksxFDE/+fkXnKhpnUUkmx5pK/v8mCtLVqZA=="
+ },
+ "node_modules/type-check": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz",
+ "integrity": "sha512-ZCmOJdvOWDBYJlzAoFkC+Q0+bUyEOS1ltgp1MGU03fqHG+dbi9tBFU2Rd9QKiDZFAYrhPh2JUf7rZRIuHRKtOg==",
+ "dependencies": {
+ "prelude-ls": "~1.1.2"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/type-fest": {
+ "version": "0.21.3",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz",
+ "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/typed-array-buffer": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz",
+ "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "es-errors": "^1.3.0",
+ "is-typed-array": "^1.1.13"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/typed-array-byte-length": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz",
+ "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "for-each": "^0.3.3",
+ "gopd": "^1.0.1",
+ "has-proto": "^1.0.3",
+ "is-typed-array": "^1.1.13"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/typed-array-byte-offset": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz",
+ "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==",
+ "dependencies": {
+ "available-typed-arrays": "^1.0.7",
+ "call-bind": "^1.0.7",
+ "for-each": "^0.3.3",
+ "gopd": "^1.0.1",
+ "has-proto": "^1.0.3",
+ "is-typed-array": "^1.1.13"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/typed-array-length": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz",
+ "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "for-each": "^0.3.3",
+ "gopd": "^1.0.1",
+ "has-proto": "^1.0.3",
+ "is-typed-array": "^1.1.13",
+ "possible-typed-array-names": "^1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/typescript": {
+ "version": "5.6.3",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz",
+ "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==",
+ "peer": true,
+ "bin": {
+ "tsc": "bin/tsc",
+ "tsserver": "bin/tsserver"
+ },
+ "engines": {
+ "node": ">=14.17"
+ }
+ },
+ "node_modules/uglify-js": {
+ "version": "3.19.3",
+ "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.19.3.tgz",
+ "integrity": "sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==",
+ "optional": true,
+ "bin": {
+ "uglifyjs": "bin/uglifyjs"
+ },
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/unbox-primitive": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz",
+ "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==",
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "has-bigints": "^1.0.2",
+ "has-symbols": "^1.0.3",
+ "which-boxed-primitive": "^1.0.2"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/underscore": {
+ "version": "1.12.1",
+ "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz",
+ "integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw=="
+ },
+ "node_modules/undici": {
+ "version": "6.20.1",
+ "resolved": "https://registry.npmjs.org/undici/-/undici-6.20.1.tgz",
+ "integrity": "sha512-AjQF1QsmqfJys+LXfGTNum+qw4S88CojRInG/6t31W/1fk6G59s92bnAvGz5Cmur+kQv2SURXEvvudLmbrE8QA==",
+ "peer": true,
+ "engines": {
+ "node": ">=18.17"
+ }
+ },
+ "node_modules/undici-types": {
+ "version": "6.19.8",
+ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz",
+ "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw=="
+ },
+ "node_modules/universalify": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz",
+ "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==",
+ "engines": {
+ "node": ">= 10.0.0"
+ }
+ },
+ "node_modules/uri-js-replace": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/uri-js-replace/-/uri-js-replace-1.0.1.tgz",
+ "integrity": "sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g=="
+ },
+ "node_modules/url-template": {
+ "version": "2.0.8",
+ "resolved": "https://registry.npmjs.org/url-template/-/url-template-2.0.8.tgz",
+ "integrity": "sha512-XdVKMF4SJ0nP/O7XIPB0JwAEuT9lDIYnNsK8yGVe43y0AWoKeJNdv3ZNWh7ksJ6KqQFjOO6ox/VEitLnaVNufw=="
+ },
+ "node_modules/use-sync-external-store": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/use-sync-external-store/-/use-sync-external-store-1.2.2.tgz",
+ "integrity": "sha512-PElTlVMwpblvbNqQ82d2n6RjStvdSoNe9FG28kNfz3WiXilJm4DdNkEzRhCZuIDwY8U08WVihhGR5iRqAwfDiw==",
+ "peerDependencies": {
+ "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
+ }
+ },
+ "node_modules/util-deprecate": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
+ "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw=="
+ },
+ "node_modules/utility-types": {
+ "version": "3.11.0",
+ "resolved": "https://registry.npmjs.org/utility-types/-/utility-types-3.11.0.tgz",
+ "integrity": "sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw==",
+ "engines": {
+ "node": ">= 4"
+ }
+ },
+ "node_modules/v8-compile-cache-lib": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz",
+ "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg=="
+ },
+ "node_modules/webidl-conversions": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
+ "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ=="
+ },
+ "node_modules/whatwg-encoding": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz",
+ "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==",
+ "peer": true,
+ "dependencies": {
+ "iconv-lite": "0.6.3"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/whatwg-mimetype": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz",
+ "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==",
+ "peer": true,
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/whatwg-url": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
+ "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
+ "dependencies": {
+ "tr46": "~0.0.3",
+ "webidl-conversions": "^3.0.0"
+ }
+ },
+ "node_modules/which": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+ "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+ "dependencies": {
+ "isexe": "^2.0.0"
+ },
+ "bin": {
+ "node-which": "bin/node-which"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/which-boxed-primitive": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz",
+ "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==",
+ "dependencies": {
+ "is-bigint": "^1.0.1",
+ "is-boolean-object": "^1.1.0",
+ "is-number-object": "^1.0.4",
+ "is-string": "^1.0.5",
+ "is-symbol": "^1.0.3"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/which-typed-array": {
+ "version": "1.1.15",
+ "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz",
+ "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==",
+ "dependencies": {
+ "available-typed-arrays": "^1.0.7",
+ "call-bind": "^1.0.7",
+ "for-each": "^0.3.3",
+ "gopd": "^1.0.1",
+ "has-tostringtag": "^1.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/widest-line": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz",
+ "integrity": "sha512-NsmoXalsWVDMGupxZ5R08ka9flZjjiLvHVAWYOKtiKM8ujtZWr9cRffak+uSE48+Ob8ObalXpwyeUiyDD6QFgg==",
+ "dependencies": {
+ "string-width": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/word-wrap": {
+ "version": "1.2.5",
+ "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz",
+ "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/wordwrap": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
+ "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q=="
+ },
+ "node_modules/wrap-ansi": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+ "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+ }
+ },
+ "node_modules/wrappy": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
+ "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="
+ },
+ "node_modules/ws": {
+ "version": "7.5.10",
+ "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz",
+ "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==",
+ "engines": {
+ "node": ">=8.3.0"
+ },
+ "peerDependencies": {
+ "bufferutil": "^4.0.1",
+ "utf-8-validate": "^5.0.2"
+ },
+ "peerDependenciesMeta": {
+ "bufferutil": {
+ "optional": true
+ },
+ "utf-8-validate": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/y18n": {
+ "version": "5.0.8",
+ "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
+ "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yaml": {
+ "version": "1.10.2",
+ "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
+ "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==",
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/yaml-ast-parser": {
+ "version": "0.0.43",
+ "resolved": "https://registry.npmjs.org/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz",
+ "integrity": "sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A=="
+ },
+ "node_modules/yargs": {
+ "version": "17.0.1",
+ "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.0.1.tgz",
+ "integrity": "sha512-xBBulfCc8Y6gLFcrPvtqKz9hz8SO0l1Ni8GgDekvBX2ro0HRQImDGnikfc33cgzcYUSncapnNcZDjVFIH3f6KQ==",
+ "dependencies": {
+ "cliui": "^7.0.2",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.0",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^20.2.2"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/yargs-parser": {
+ "version": "20.2.9",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz",
+ "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yn": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz",
+ "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==",
+ "engines": {
+ "node": ">=6"
+ }
+ }
+ }
+}
diff --git a/oas_docs/package.json b/oas_docs/package.json
new file mode 100644
index 0000000000000..3f6cae5c044b3
--- /dev/null
+++ b/oas_docs/package.json
@@ -0,0 +1,19 @@
+{
+ "name": "oas_docs",
+ "version": "1.0.0",
+ "description": "Documentation about our OpenAPI bundling workflow and configuration. See Kibana's hosted [stateful](https://www.elastic.co/docs/api/doc/kibana) and [serverless](https://www.elastic.co/docs/api/doc/serverless) docs.",
+ "main": "index.js",
+ "directories": {
+ "example": "examples"
+ },
+ "dependencies": {
+ "bump-cli": "^2.8.4",
+ "@redocly/cli": "^1.25.11"
+ },
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "ISC"
+}
diff --git a/package.json b/package.json
index e2491ea76b89b..0929ea1114a16 100644
--- a/package.json
+++ b/package.json
@@ -104,6 +104,7 @@
"@appland/sql-parser": "^1.5.1",
"@aws-crypto/sha256-js": "^5.2.0",
"@aws-crypto/util": "^5.2.0",
+ "@aws-sdk/client-bedrock-runtime": "^3.687.0",
"@babel/runtime": "^7.24.7",
"@dagrejs/dagre": "^1.1.4",
"@dnd-kit/core": "^6.1.0",
@@ -118,7 +119,8 @@
"@elastic/ecs": "^8.11.1",
"@elastic/elasticsearch": "^8.15.2",
"@elastic/ems-client": "8.5.3",
- "@elastic/eui": "97.3.1",
+ "@elastic/eui": "97.3.1-borealis.2",
+ "@elastic/eui-theme-borealis": "0.0.2",
"@elastic/filesaver": "1.1.2",
"@elastic/node-crypto": "^1.2.3",
"@elastic/numeral": "^2.5.1",
@@ -232,6 +234,7 @@
"@kbn/content-management-content-insights-public": "link:packages/content-management/content_insights/content_insights_public",
"@kbn/content-management-content-insights-server": "link:packages/content-management/content_insights/content_insights_server",
"@kbn/content-management-examples-plugin": "link:examples/content_management_examples",
+ "@kbn/content-management-favorites-common": "link:packages/content-management/favorites/favorites_common",
"@kbn/content-management-favorites-public": "link:packages/content-management/favorites/favorites_public",
"@kbn/content-management-favorites-server": "link:packages/content-management/favorites/favorites_server",
"@kbn/content-management-plugin": "link:src/plugins/content_management",
@@ -360,6 +363,7 @@
"@kbn/core-preboot-server": "link:packages/core/preboot/core-preboot-server",
"@kbn/core-preboot-server-internal": "link:packages/core/preboot/core-preboot-server-internal",
"@kbn/core-provider-plugin": "link:test/plugin_functional/plugins/core_provider_plugin",
+ "@kbn/core-rendering-browser": "link:packages/core/rendering/core-rendering-browser",
"@kbn/core-rendering-browser-internal": "link:packages/core/rendering/core-rendering-browser-internal",
"@kbn/core-rendering-server-internal": "link:packages/core/rendering/core-rendering-server-internal",
"@kbn/core-root-browser-internal": "link:packages/core/root/core-root-browser-internal",
@@ -384,7 +388,6 @@
"@kbn/core-security-server-internal": "link:packages/core/security/core-security-server-internal",
"@kbn/core-security-server-mocks": "link:packages/core/security/core-security-server-mocks",
"@kbn/core-status-common": "link:packages/core/status/core-status-common",
- "@kbn/core-status-common-internal": "link:packages/core/status/core-status-common-internal",
"@kbn/core-status-server": "link:packages/core/status/core-status-server",
"@kbn/core-status-server-internal": "link:packages/core/status/core-status-server-internal",
"@kbn/core-test-helpers-deprecations-getters": "link:packages/core/test-helpers/core-test-helpers-deprecations-getters",
@@ -616,6 +619,7 @@
"@kbn/licensing-plugin": "link:x-pack/plugins/licensing",
"@kbn/links-plugin": "link:src/plugins/links",
"@kbn/lists-plugin": "link:x-pack/plugins/lists",
+ "@kbn/llm-tasks-plugin": "link:x-pack/plugins/ai_infra/llm_tasks",
"@kbn/locator-examples-plugin": "link:examples/locator_examples",
"@kbn/locator-explorer-plugin": "link:examples/locator_explorer",
"@kbn/logging": "link:packages/kbn-logging",
@@ -702,7 +706,9 @@
"@kbn/observability-plugin": "link:x-pack/plugins/observability_solution/observability",
"@kbn/observability-shared-plugin": "link:x-pack/plugins/observability_solution/observability_shared",
"@kbn/observability-synthetics-test-data": "link:x-pack/packages/observability/synthetics_test_data",
- "@kbn/observability-utils": "link:x-pack/packages/observability/observability_utils",
+ "@kbn/observability-utils-browser": "link:x-pack/packages/observability/observability_utils/observability_utils_browser",
+ "@kbn/observability-utils-common": "link:x-pack/packages/observability/observability_utils/observability_utils_common",
+ "@kbn/observability-utils-server": "link:x-pack/packages/observability/observability_utils/observability_utils_server",
"@kbn/oidc-provider-plugin": "link:x-pack/test/security_api_integration/plugins/oidc_provider",
"@kbn/open-telemetry-instrumented-plugin": "link:test/common/plugins/otel_metrics",
"@kbn/openapi-common": "link:packages/kbn-openapi-common",
@@ -718,6 +724,8 @@
"@kbn/presentation-panel-plugin": "link:src/plugins/presentation_panel",
"@kbn/presentation-publishing": "link:packages/presentation/presentation_publishing",
"@kbn/presentation-util-plugin": "link:src/plugins/presentation_util",
+ "@kbn/product-doc-base-plugin": "link:x-pack/plugins/ai_infra/product_doc_base",
+ "@kbn/product-doc-common": "link:x-pack/packages/ai-infra/product-doc-common",
"@kbn/profiling-data-access-plugin": "link:x-pack/plugins/observability_solution/profiling_data_access",
"@kbn/profiling-plugin": "link:x-pack/plugins/observability_solution/profiling",
"@kbn/profiling-utils": "link:packages/kbn-profiling-utils",
@@ -1012,7 +1020,8 @@
"@kbn/xstate-utils": "link:packages/kbn-xstate-utils",
"@kbn/zod": "link:packages/kbn-zod",
"@kbn/zod-helpers": "link:packages/kbn-zod-helpers",
- "@langchain/community": "0.3.11",
+ "@langchain/aws": "^0.1.2",
+ "@langchain/community": "0.3.14",
"@langchain/core": "^0.3.16",
"@langchain/google-common": "^0.1.1",
"@langchain/google-genai": "^0.1.2",
@@ -1020,7 +1029,7 @@
"@langchain/langgraph": "0.2.19",
"@langchain/openai": "^0.3.11",
"@langtrase/trace-attributes": "^3.0.8",
- "@launchdarkly/node-server-sdk": "^9.7.0",
+ "@launchdarkly/node-server-sdk": "^9.7.1",
"@launchdarkly/openfeature-node-server": "^1.0.0",
"@loaders.gl/core": "^3.4.7",
"@loaders.gl/json": "^3.4.7",
@@ -1047,7 +1056,9 @@
"@slack/webhook": "^7.0.1",
"@smithy/eventstream-codec": "^3.1.1",
"@smithy/eventstream-serde-node": "^3.0.3",
- "@smithy/protocol-http": "^4.0.2",
+ "@smithy/middleware-stack": "^3.0.10",
+ "@smithy/node-http-handler": "^3.3.1",
+ "@smithy/protocol-http": "^4.1.7",
"@smithy/signature-v4": "^3.1.1",
"@smithy/types": "^3.2.0",
"@smithy/util-utf8": "^3.0.0",
@@ -1065,7 +1076,7 @@
"@turf/length": "^6.0.2",
"@xstate/react": "^3.2.2",
"@xstate5/react": "npm:@xstate/react@^4.1.2",
- "@xyflow/react": "^12.3.4",
+ "@xyflow/react": "^12.3.5",
"adm-zip": "^0.5.9",
"ai": "^2.2.33",
"ajv": "^8.12.0",
@@ -1631,7 +1642,7 @@
"@types/resolve": "^1.20.1",
"@types/scheduler": "^0.23.0",
"@types/seedrandom": ">=2.0.0 <4.0.0",
- "@types/selenium-webdriver": "^4.1.26",
+ "@types/selenium-webdriver": "^4.1.27",
"@types/semver": "^7.5.8",
"@types/set-value": "^2.0.0",
"@types/sinon": "^7.0.13",
@@ -1678,7 +1689,7 @@
"buildkite-test-collector": "^1.7.0",
"callsites": "^3.1.0",
"chance": "1.0.18",
- "chromedriver": "^130.0.1",
+ "chromedriver": "^130.0.4",
"clarify": "^2.2.0",
"clean-webpack-plugin": "^3.0.0",
"cli-progress": "^3.12.0",
@@ -1705,7 +1716,7 @@
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-ban": "^1.6.0",
"eslint-plugin-cypress": "^2.15.1",
- "eslint-plugin-depend": "^0.11.0",
+ "eslint-plugin-depend": "^0.12.0",
"eslint-plugin-eslint-comments": "^3.2.0",
"eslint-plugin-formatjs": "^4.12.2",
"eslint-plugin-import": "^2.28.0",
@@ -1729,7 +1740,7 @@
"file-loader": "^4.2.0",
"find-cypress-specs": "^1.41.4",
"form-data": "^4.0.0",
- "geckodriver": "^4.5.1",
+ "geckodriver": "^5.0.0",
"gulp-brotli": "^3.0.0",
"gulp-postcss": "^9.0.1",
"gulp-terser": "^2.1.0",
@@ -1804,7 +1815,7 @@
"rxjs-marbles": "^7.0.1",
"sass-embedded": "^1.78.0",
"sass-loader": "^10.5.1",
- "selenium-webdriver": "^4.25.0",
+ "selenium-webdriver": "^4.26.0",
"sharp": "0.32.6",
"simple-git": "^3.16.0",
"sinon": "^7.4.2",
diff --git a/packages/content-management/favorites/favorites_common/README.md b/packages/content-management/favorites/favorites_common/README.md
new file mode 100644
index 0000000000000..61608fa380e20
--- /dev/null
+++ b/packages/content-management/favorites/favorites_common/README.md
@@ -0,0 +1,3 @@
+# @kbn/content-management-favorites-common
+
+Shared client & server code for the favorites packages.
diff --git a/src/plugins/saved_objects/public/saved_object/helpers/field_mapping/index.ts b/packages/content-management/favorites/favorites_common/index.ts
similarity index 80%
rename from src/plugins/saved_objects/public/saved_object/helpers/field_mapping/index.ts
rename to packages/content-management/favorites/favorites_common/index.ts
index 850352da2b188..05ad1fa0b9cef 100644
--- a/src/plugins/saved_objects/public/saved_object/helpers/field_mapping/index.ts
+++ b/packages/content-management/favorites/favorites_common/index.ts
@@ -7,5 +7,5 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-export type { FieldMappingSpec, MappingObject } from './types';
-export { expandShorthand } from './mapping_setup';
+// Limit the number of favorites to prevent too large objects due to metadata
+export const FAVORITES_LIMIT = 100;
diff --git a/packages/core/status/core-status-common-internal/src/index.ts b/packages/content-management/favorites/favorites_common/jest.config.js
similarity index 74%
rename from packages/core/status/core-status-common-internal/src/index.ts
rename to packages/content-management/favorites/favorites_common/jest.config.js
index 60c51dcf47632..c8b618b4f4ac6 100644
--- a/packages/core/status/core-status-common-internal/src/index.ts
+++ b/packages/content-management/favorites/favorites_common/jest.config.js
@@ -7,11 +7,8 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-export type {
- StatusInfo,
- StatusInfoCoreStatus,
- StatusInfoServiceStatus,
- StatusResponse,
- ServerVersion,
- ServerMetrics,
-} from './status';
+module.exports = {
+ preset: '@kbn/test/jest_node',
+ rootDir: '../../../..',
+ roots: ['/packages/content-management/favorites/favorites_common'],
+};
diff --git a/packages/content-management/favorites/favorites_common/kibana.jsonc b/packages/content-management/favorites/favorites_common/kibana.jsonc
new file mode 100644
index 0000000000000..69e13e656639b
--- /dev/null
+++ b/packages/content-management/favorites/favorites_common/kibana.jsonc
@@ -0,0 +1,5 @@
+{
+ "type": "shared-common",
+ "id": "@kbn/content-management-favorites-common",
+ "owner": "@elastic/appex-sharedux"
+}
diff --git a/packages/content-management/favorites/favorites_common/package.json b/packages/content-management/favorites/favorites_common/package.json
new file mode 100644
index 0000000000000..cb3a685ebc064
--- /dev/null
+++ b/packages/content-management/favorites/favorites_common/package.json
@@ -0,0 +1,6 @@
+{
+ "name": "@kbn/content-management-favorites-common",
+ "private": true,
+ "version": "1.0.0",
+ "license": "Elastic License 2.0 OR AGPL-3.0-only OR SSPL-1.0"
+}
\ No newline at end of file
diff --git a/packages/content-management/favorites/favorites_common/tsconfig.json b/packages/content-management/favorites/favorites_common/tsconfig.json
new file mode 100644
index 0000000000000..0d78dace105e1
--- /dev/null
+++ b/packages/content-management/favorites/favorites_common/tsconfig.json
@@ -0,0 +1,17 @@
+{
+ "extends": "../../../../tsconfig.base.json",
+ "compilerOptions": {
+ "outDir": "target/types",
+ "types": [
+ "jest",
+ "node"
+ ]
+ },
+ "include": [
+ "**/*.ts",
+ ],
+ "exclude": [
+ "target/**/*"
+ ],
+ "kbn_references": []
+}
diff --git a/packages/content-management/favorites/favorites_public/src/favorites_client.ts b/packages/content-management/favorites/favorites_public/src/favorites_client.ts
index 3b3d439caecda..84c44db5fd64c 100644
--- a/packages/content-management/favorites/favorites_public/src/favorites_client.ts
+++ b/packages/content-management/favorites/favorites_public/src/favorites_client.ts
@@ -9,36 +9,52 @@
import type { HttpStart } from '@kbn/core-http-browser';
import type { UsageCollectionStart } from '@kbn/usage-collection-plugin/public';
-import type { GetFavoritesResponse } from '@kbn/content-management-favorites-server';
+import type {
+ GetFavoritesResponse as GetFavoritesResponseServer,
+ AddFavoriteResponse,
+ RemoveFavoriteResponse,
+} from '@kbn/content-management-favorites-server';
-export interface FavoritesClientPublic {
- getFavorites(): Promise;
- addFavorite({ id }: { id: string }): Promise;
- removeFavorite({ id }: { id: string }): Promise;
+export interface GetFavoritesResponse
+ extends GetFavoritesResponseServer {
+ favoriteMetadata: Metadata extends object ? Record : never;
+}
+
+type AddFavoriteRequest = Metadata extends object
+ ? { id: string; metadata: Metadata }
+ : { id: string };
+
+export interface FavoritesClientPublic {
+ getFavorites(): Promise>;
+ addFavorite(params: AddFavoriteRequest): Promise;
+ removeFavorite(params: { id: string }): Promise;
getFavoriteType(): string;
reportAddFavoriteClick(): void;
reportRemoveFavoriteClick(): void;
}
-export class FavoritesClient implements FavoritesClientPublic {
+export class FavoritesClient
+ implements FavoritesClientPublic
+{
constructor(
private readonly appName: string,
private readonly favoriteObjectType: string,
private readonly deps: { http: HttpStart; usageCollection?: UsageCollectionStart }
) {}
- public async getFavorites(): Promise {
+ public async getFavorites(): Promise> {
return this.deps.http.get(`/internal/content_management/favorites/${this.favoriteObjectType}`);
}
- public async addFavorite({ id }: { id: string }): Promise {
+ public async addFavorite(params: AddFavoriteRequest): Promise {
return this.deps.http.post(
- `/internal/content_management/favorites/${this.favoriteObjectType}/${id}/favorite`
+ `/internal/content_management/favorites/${this.favoriteObjectType}/${params.id}/favorite`,
+ { body: 'metadata' in params ? JSON.stringify({ metadata: params.metadata }) : undefined }
);
}
- public async removeFavorite({ id }: { id: string }): Promise {
+ public async removeFavorite({ id }: { id: string }): Promise {
return this.deps.http.post(
`/internal/content_management/favorites/${this.favoriteObjectType}/${id}/unfavorite`
);
diff --git a/packages/content-management/favorites/favorites_public/src/favorites_query.tsx b/packages/content-management/favorites/favorites_public/src/favorites_query.tsx
index e3ca1e4ed202d..63e8ad3a7ef75 100644
--- a/packages/content-management/favorites/favorites_public/src/favorites_query.tsx
+++ b/packages/content-management/favorites/favorites_public/src/favorites_query.tsx
@@ -11,6 +11,7 @@ import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query';
import { i18n } from '@kbn/i18n';
import React from 'react';
+import type { IHttpFetchError } from '@kbn/core-http-browser';
import { useFavoritesClient, useFavoritesContext } from './favorites_context';
const favoritesKeys = {
@@ -54,14 +55,14 @@ export const useAddFavorite = () => {
onSuccess: (data) => {
queryClient.setQueryData(favoritesKeys.byType(favoritesClient!.getFavoriteType()), data);
},
- onError: (error: Error) => {
+ onError: (error: IHttpFetchError<{ message?: string }>) => {
notifyError?.(
<>
{i18n.translate('contentManagement.favorites.addFavoriteError', {
defaultMessage: 'Error adding to Starred',
})}
,
- error?.message
+ error?.body?.message ?? error.message
);
},
}
diff --git a/packages/content-management/favorites/favorites_server/index.ts b/packages/content-management/favorites/favorites_server/index.ts
index bcb8d0bffba8c..2810102d9165c 100644
--- a/packages/content-management/favorites/favorites_server/index.ts
+++ b/packages/content-management/favorites/favorites_server/index.ts
@@ -7,4 +7,10 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-export { registerFavorites, type GetFavoritesResponse } from './src';
+export {
+ registerFavorites,
+ type GetFavoritesResponse,
+ type FavoritesSetup,
+ type AddFavoriteResponse,
+ type RemoveFavoriteResponse,
+} from './src';
diff --git a/packages/content-management/favorites/favorites_server/src/favorites_registry.ts b/packages/content-management/favorites/favorites_server/src/favorites_registry.ts
new file mode 100644
index 0000000000000..53fc6dc4b5260
--- /dev/null
+++ b/packages/content-management/favorites/favorites_server/src/favorites_registry.ts
@@ -0,0 +1,50 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+import { ObjectType } from '@kbn/config-schema';
+
+interface FavoriteTypeConfig {
+ typeMetadataSchema?: ObjectType;
+}
+
+export type FavoritesRegistrySetup = Pick;
+
+export class FavoritesRegistry {
+ private favoriteTypes = new Map();
+
+ registerFavoriteType(type: string, config: FavoriteTypeConfig = {}) {
+ if (this.favoriteTypes.has(type)) {
+ throw new Error(`Favorite type ${type} is already registered`);
+ }
+
+ this.favoriteTypes.set(type, config);
+ }
+
+ hasType(type: string) {
+ return this.favoriteTypes.has(type);
+ }
+
+ validateMetadata(type: string, metadata?: object) {
+ if (!this.hasType(type)) {
+ throw new Error(`Favorite type ${type} is not registered`);
+ }
+
+ const typeConfig = this.favoriteTypes.get(type)!;
+ const typeMetadataSchema = typeConfig.typeMetadataSchema;
+
+ if (typeMetadataSchema) {
+ typeMetadataSchema.validate(metadata);
+ } else {
+ if (metadata === undefined) {
+ return; /* ok */
+ } else {
+ throw new Error(`Favorite type ${type} does not support metadata`);
+ }
+ }
+ }
+}
diff --git a/packages/content-management/favorites/favorites_server/src/favorites_routes.ts b/packages/content-management/favorites/favorites_server/src/favorites_routes.ts
index 663d0181f3806..512b2cbe1260e 100644
--- a/packages/content-management/favorites/favorites_server/src/favorites_routes.ts
+++ b/packages/content-management/favorites/favorites_server/src/favorites_routes.ts
@@ -14,12 +14,9 @@ import {
SECURITY_EXTENSION_ID,
} from '@kbn/core/server';
import { schema } from '@kbn/config-schema';
-import { FavoritesService } from './favorites_service';
+import { FavoritesService, FavoritesLimitExceededError } from './favorites_service';
import { favoritesSavedObjectType } from './favorites_saved_object';
-
-// only dashboard is supported for now
-// TODO: make configurable or allow any string
-const typeSchema = schema.oneOf([schema.literal('dashboard')]);
+import { FavoritesRegistry } from './favorites_registry';
/**
* @public
@@ -27,9 +24,45 @@ const typeSchema = schema.oneOf([schema.literal('dashboard')]);
*/
export interface GetFavoritesResponse {
favoriteIds: string[];
+ favoriteMetadata?: Record;
+}
+
+export interface AddFavoriteResponse {
+ favoriteIds: string[];
}
-export function registerFavoritesRoutes({ core, logger }: { core: CoreSetup; logger: Logger }) {
+export interface RemoveFavoriteResponse {
+ favoriteIds: string[];
+}
+
+export function registerFavoritesRoutes({
+ core,
+ logger,
+ favoritesRegistry,
+}: {
+ core: CoreSetup;
+ logger: Logger;
+ favoritesRegistry: FavoritesRegistry;
+}) {
+ const typeSchema = schema.string({
+ validate: (type) => {
+ if (!favoritesRegistry.hasType(type)) {
+ return `Unknown favorite type: ${type}`;
+ }
+ },
+ });
+
+ const metadataSchema = schema.maybe(
+ schema.object(
+ {
+ // validated later by the registry depending on the type
+ },
+ {
+ unknowns: 'allow',
+ }
+ )
+ );
+
const router = core.http.createRouter();
const getSavedObjectClient = (coreRequestHandlerContext: CoreRequestHandlerContext) => {
@@ -49,6 +82,13 @@ export function registerFavoritesRoutes({ core, logger }: { core: CoreSetup; log
id: schema.string(),
type: typeSchema,
}),
+ body: schema.maybe(
+ schema.nullable(
+ schema.object({
+ metadata: metadataSchema,
+ })
+ )
+ ),
},
// we don't protect the route with any access tags as
// we only give access to the current user's favorites ids
@@ -67,13 +107,35 @@ export function registerFavoritesRoutes({ core, logger }: { core: CoreSetup; log
const favorites = new FavoritesService(type, userId, {
savedObjectClient: getSavedObjectClient(coreRequestHandlerContext),
logger,
+ favoritesRegistry,
});
- const favoriteIds: GetFavoritesResponse = await favorites.addFavorite({
- id: request.params.id,
- });
+ const id = request.params.id;
+ const metadata = request.body?.metadata;
- return response.ok({ body: favoriteIds });
+ try {
+ favoritesRegistry.validateMetadata(type, metadata);
+ } catch (e) {
+ return response.badRequest({ body: { message: e.message } });
+ }
+
+ try {
+ const favoritesResult = await favorites.addFavorite({
+ id,
+ metadata,
+ });
+ const addFavoritesResponse: AddFavoriteResponse = {
+ favoriteIds: favoritesResult.favoriteIds,
+ };
+
+ return response.ok({ body: addFavoritesResponse });
+ } catch (e) {
+ if (e instanceof FavoritesLimitExceededError) {
+ return response.forbidden({ body: { message: e.message } });
+ }
+
+ throw e; // unexpected error, let the global error handler deal with it
+ }
}
);
@@ -102,12 +164,18 @@ export function registerFavoritesRoutes({ core, logger }: { core: CoreSetup; log
const favorites = new FavoritesService(type, userId, {
savedObjectClient: getSavedObjectClient(coreRequestHandlerContext),
logger,
+ favoritesRegistry,
});
- const favoriteIds: GetFavoritesResponse = await favorites.removeFavorite({
+ const favoritesResult: GetFavoritesResponse = await favorites.removeFavorite({
id: request.params.id,
});
- return response.ok({ body: favoriteIds });
+
+ const removeFavoriteResponse: RemoveFavoriteResponse = {
+ favoriteIds: favoritesResult.favoriteIds,
+ };
+
+ return response.ok({ body: removeFavoriteResponse });
}
);
@@ -135,12 +203,18 @@ export function registerFavoritesRoutes({ core, logger }: { core: CoreSetup; log
const favorites = new FavoritesService(type, userId, {
savedObjectClient: getSavedObjectClient(coreRequestHandlerContext),
logger,
+ favoritesRegistry,
});
- const getFavoritesResponse: GetFavoritesResponse = await favorites.getFavorites();
+ const favoritesResult = await favorites.getFavorites();
+
+ const favoritesResponse: GetFavoritesResponse = {
+ favoriteIds: favoritesResult.favoriteIds,
+ favoriteMetadata: favoritesResult.favoriteMetadata,
+ };
return response.ok({
- body: getFavoritesResponse,
+ body: favoritesResponse,
});
}
);
diff --git a/packages/content-management/favorites/favorites_server/src/favorites_saved_object.ts b/packages/content-management/favorites/favorites_server/src/favorites_saved_object.ts
index 73cd3b3ca185f..776133f408975 100644
--- a/packages/content-management/favorites/favorites_server/src/favorites_saved_object.ts
+++ b/packages/content-management/favorites/favorites_server/src/favorites_saved_object.ts
@@ -14,6 +14,7 @@ export interface FavoritesSavedObjectAttributes {
userId: string;
type: string;
favoriteIds: string[];
+ favoriteMetadata?: Record;
}
const schemaV1 = schema.object({
@@ -22,6 +23,10 @@ const schemaV1 = schema.object({
favoriteIds: schema.arrayOf(schema.string()),
});
+const schemaV3 = schemaV1.extends({
+ favoriteMetadata: schema.maybe(schema.object({}, { unknowns: 'allow' })),
+});
+
export const favoritesSavedObjectName = 'favorites';
export const favoritesSavedObjectType: SavedObjectsType = {
@@ -34,6 +39,7 @@ export const favoritesSavedObjectType: SavedObjectsType = {
userId: { type: 'keyword' },
type: { type: 'keyword' },
favoriteIds: { type: 'keyword' },
+ favoriteMetadata: { type: 'object', dynamic: false },
},
},
modelVersions: {
@@ -65,5 +71,19 @@ export const favoritesSavedObjectType: SavedObjectsType = {
create: schemaV1,
},
},
+ 3: {
+ changes: [
+ {
+ type: 'mappings_addition',
+ addedMappings: {
+ favoriteMetadata: { type: 'object', dynamic: false },
+ },
+ },
+ ],
+ schemas: {
+ forwardCompatibility: schemaV3.extends({}, { unknowns: 'ignore' }),
+ create: schemaV3,
+ },
+ },
},
};
diff --git a/packages/content-management/favorites/favorites_server/src/favorites_service.ts b/packages/content-management/favorites/favorites_server/src/favorites_service.ts
index 41c9b10f05507..6258e66897fa3 100644
--- a/packages/content-management/favorites/favorites_server/src/favorites_service.ts
+++ b/packages/content-management/favorites/favorites_server/src/favorites_service.ts
@@ -7,9 +7,17 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
+// eslint-disable-next-line max-classes-per-file
import type { SavedObject, SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server';
+import { FAVORITES_LIMIT } from '@kbn/content-management-favorites-common';
import { Logger, SavedObjectsErrorHelpers } from '@kbn/core/server';
import { favoritesSavedObjectType, FavoritesSavedObjectAttributes } from './favorites_saved_object';
+import { FavoritesRegistry } from './favorites_registry';
+
+export interface FavoritesState {
+ favoriteIds: string[];
+ favoriteMetadata?: Record;
+}
export class FavoritesService {
constructor(
@@ -18,23 +26,38 @@ export class FavoritesService {
private readonly deps: {
savedObjectClient: SavedObjectsClientContract;
logger: Logger;
+ favoritesRegistry: FavoritesRegistry;
}
) {
if (!this.userId || !this.type) {
// This should never happen, but just in case let's do a runtime check
throw new Error('userId and object type are required to use a favorite service');
}
+
+ if (!this.deps.favoritesRegistry.hasType(this.type)) {
+ throw new Error(`Favorite type ${this.type} is not registered`);
+ }
}
- public async getFavorites(): Promise<{ favoriteIds: string[] }> {
+ public async getFavorites(): Promise {
const favoritesSavedObject = await this.getFavoritesSavedObject();
const favoriteIds = favoritesSavedObject?.attributes?.favoriteIds ?? [];
+ const favoriteMetadata = favoritesSavedObject?.attributes?.favoriteMetadata;
- return { favoriteIds };
+ return { favoriteIds, favoriteMetadata };
}
- public async addFavorite({ id }: { id: string }): Promise<{ favoriteIds: string[] }> {
+ /**
+ * @throws {FavoritesLimitExceededError}
+ */
+ public async addFavorite({
+ id,
+ metadata,
+ }: {
+ id: string;
+ metadata?: object;
+ }): Promise {
let favoritesSavedObject = await this.getFavoritesSavedObject();
if (!favoritesSavedObject) {
@@ -44,14 +67,28 @@ export class FavoritesService {
userId: this.userId,
type: this.type,
favoriteIds: [id],
+ ...(metadata
+ ? {
+ favoriteMetadata: {
+ [id]: metadata,
+ },
+ }
+ : {}),
},
{
id: this.getFavoriteSavedObjectId(),
}
);
- return { favoriteIds: favoritesSavedObject.attributes.favoriteIds };
+ return {
+ favoriteIds: favoritesSavedObject.attributes.favoriteIds,
+ favoriteMetadata: favoritesSavedObject.attributes.favoriteMetadata,
+ };
} else {
+ if ((favoritesSavedObject.attributes.favoriteIds ?? []).length >= FAVORITES_LIMIT) {
+ throw new FavoritesLimitExceededError();
+ }
+
const newFavoriteIds = [
...(favoritesSavedObject.attributes.favoriteIds ?? []).filter(
(favoriteId) => favoriteId !== id
@@ -59,22 +96,34 @@ export class FavoritesService {
id,
];
+ const newFavoriteMetadata = metadata
+ ? {
+ ...favoritesSavedObject.attributes.favoriteMetadata,
+ [id]: metadata,
+ }
+ : undefined;
+
await this.deps.savedObjectClient.update(
favoritesSavedObjectType.name,
favoritesSavedObject.id,
{
favoriteIds: newFavoriteIds,
+ ...(newFavoriteMetadata
+ ? {
+ favoriteMetadata: newFavoriteMetadata,
+ }
+ : {}),
},
{
version: favoritesSavedObject.version,
}
);
- return { favoriteIds: newFavoriteIds };
+ return { favoriteIds: newFavoriteIds, favoriteMetadata: newFavoriteMetadata };
}
}
- public async removeFavorite({ id }: { id: string }): Promise<{ favoriteIds: string[] }> {
+ public async removeFavorite({ id }: { id: string }): Promise {
const favoritesSavedObject = await this.getFavoritesSavedObject();
if (!favoritesSavedObject) {
@@ -85,19 +134,36 @@ export class FavoritesService {
(favoriteId) => favoriteId !== id
);
+ const newFavoriteMetadata = favoritesSavedObject.attributes.favoriteMetadata
+ ? { ...favoritesSavedObject.attributes.favoriteMetadata }
+ : undefined;
+
+ if (newFavoriteMetadata) {
+ delete newFavoriteMetadata[id];
+ }
+
await this.deps.savedObjectClient.update(
favoritesSavedObjectType.name,
favoritesSavedObject.id,
{
+ ...favoritesSavedObject.attributes,
favoriteIds: newFavoriteIds,
+ ...(newFavoriteMetadata
+ ? {
+ favoriteMetadata: newFavoriteMetadata,
+ }
+ : {}),
},
{
version: favoritesSavedObject.version,
+ // We don't want to merge the attributes here because we want to remove the keys from the metadata
+ mergeAttributes: false,
}
);
return {
favoriteIds: newFavoriteIds,
+ favoriteMetadata: newFavoriteMetadata,
};
}
@@ -123,3 +189,14 @@ export class FavoritesService {
return `${this.type}:${this.userId}`;
}
}
+
+export class FavoritesLimitExceededError extends Error {
+ constructor() {
+ super(
+ `Limit reached: This list can contain a maximum of ${FAVORITES_LIMIT} items. Please remove an item before adding a new one.`
+ );
+
+ this.name = 'FavoritesLimitExceededError';
+ Object.setPrototypeOf(this, FavoritesLimitExceededError.prototype); // For TypeScript compatibility
+ }
+}
diff --git a/packages/content-management/favorites/favorites_server/src/index.ts b/packages/content-management/favorites/favorites_server/src/index.ts
index d6cdd51285b38..44e3b9f259a33 100644
--- a/packages/content-management/favorites/favorites_server/src/index.ts
+++ b/packages/content-management/favorites/favorites_server/src/index.ts
@@ -12,8 +12,19 @@ import type { UsageCollectionSetup } from '@kbn/usage-collection-plugin/server';
import { registerFavoritesRoutes } from './favorites_routes';
import { favoritesSavedObjectType } from './favorites_saved_object';
import { registerFavoritesUsageCollection } from './favorites_usage_collection';
+import { FavoritesRegistry, FavoritesRegistrySetup } from './favorites_registry';
-export type { GetFavoritesResponse } from './favorites_routes';
+export type {
+ GetFavoritesResponse,
+ AddFavoriteResponse,
+ RemoveFavoriteResponse,
+} from './favorites_routes';
+
+/**
+ * @public
+ * Setup contract for the favorites feature.
+ */
+export type FavoritesSetup = FavoritesRegistrySetup;
/**
* @public
@@ -31,11 +42,14 @@ export function registerFavorites({
core: CoreSetup;
logger: Logger;
usageCollection?: UsageCollectionSetup;
-}) {
+}): FavoritesSetup {
+ const favoritesRegistry = new FavoritesRegistry();
core.savedObjects.registerType(favoritesSavedObjectType);
- registerFavoritesRoutes({ core, logger });
+ registerFavoritesRoutes({ core, logger, favoritesRegistry });
if (usageCollection) {
registerFavoritesUsageCollection({ core, usageCollection });
}
+
+ return favoritesRegistry;
}
diff --git a/packages/content-management/favorites/favorites_server/tsconfig.json b/packages/content-management/favorites/favorites_server/tsconfig.json
index 5a9ae392c875b..bbab19ade978b 100644
--- a/packages/content-management/favorites/favorites_server/tsconfig.json
+++ b/packages/content-management/favorites/favorites_server/tsconfig.json
@@ -19,5 +19,6 @@
"@kbn/core-saved-objects-api-server",
"@kbn/core-lifecycle-server",
"@kbn/usage-collection-plugin",
+ "@kbn/content-management-favorites-common",
]
}
diff --git a/packages/content-management/table_list_view_table/src/mocks.tsx b/packages/content-management/table_list_view_table/src/mocks.tsx
index 5d387096d829d..0697e5b14ad83 100644
--- a/packages/content-management/table_list_view_table/src/mocks.tsx
+++ b/packages/content-management/table_list_view_table/src/mocks.tsx
@@ -9,6 +9,7 @@
import React from 'react';
import { from } from 'rxjs';
+import type { IStorage } from '@kbn/kibana-utils-plugin/public';
import type { Services, TagListProps } from './services';
@@ -149,3 +150,22 @@ export const getStoryArgTypes = () => ({
defaultValue: false,
},
});
+
+export const localStorageMock = (): IStorage => {
+ let store: Record = {};
+
+ return {
+ getItem: (key: string) => {
+ return store[key] || null;
+ },
+ setItem: (key: string, value: unknown) => {
+ store[key] = value;
+ },
+ clear() {
+ store = {};
+ },
+ removeItem(key: string) {
+ delete store[key];
+ },
+ };
+};
diff --git a/packages/content-management/table_list_view_table/src/table_list_view.test.tsx b/packages/content-management/table_list_view_table/src/table_list_view.test.tsx
index 38229399f2ec8..aebaca335db5f 100644
--- a/packages/content-management/table_list_view_table/src/table_list_view.test.tsx
+++ b/packages/content-management/table_list_view_table/src/table_list_view.test.tsx
@@ -18,7 +18,7 @@ import type { LocationDescriptor, History } from 'history';
import type { UserContentCommonSchema } from '@kbn/content-management-table-list-view-common';
import { WithServices } from './__jest__';
-import { getTagList } from './mocks';
+import { getTagList, localStorageMock } from './mocks';
import { TableListViewTable, type TableListViewTableProps } from './table_list_view_table';
import { getActions } from './table_list_view.test.helpers';
import type { Services } from './services';
@@ -335,6 +335,12 @@ describe('TableListView', () => {
const totalItems = 30;
const updatedAt = new Date().toISOString();
+ beforeEach(() => {
+ Object.defineProperty(window, 'localStorage', {
+ value: localStorageMock(),
+ });
+ });
+
const hits: UserContentCommonSchema[] = [...Array(totalItems)].map((_, i) => ({
id: `item${i}`,
type: 'dashboard',
@@ -429,6 +435,54 @@ describe('TableListView', () => {
expect(firstRowTitle).toBe('Item 20');
expect(lastRowTitle).toBe('Item 29');
});
+
+ test('should persist the number of rows in the table', async () => {
+ let testBed: TestBed;
+
+ const tableId = 'myTable';
+
+ await act(async () => {
+ testBed = await setup({
+ initialPageSize,
+ findItems: jest.fn().mockResolvedValue({ total: hits.length, hits: [...hits] }),
+ id: tableId,
+ });
+ });
+
+ {
+ const { component, table, find } = testBed!;
+ component.update();
+
+ const { tableCellsValues } = table.getMetaData('itemsInMemTable');
+ expect(tableCellsValues.length).toBe(20); // 20 by default
+
+ let storageValue = localStorage.getItem(`tablePersist:${tableId}`);
+ expect(storageValue).toBe(null);
+
+ find('tablePaginationPopoverButton').simulate('click');
+ find('tablePagination-10-rows').simulate('click');
+
+ storageValue = localStorage.getItem(`tablePersist:${tableId}`);
+ expect(storageValue).not.toBe(null);
+ expect(JSON.parse(storageValue!).pageSize).toBe(10);
+ }
+
+ // Mount a second table and verify that is shows only 10 rows
+ {
+ await act(async () => {
+ testBed = await setup({
+ initialPageSize,
+ findItems: jest.fn().mockResolvedValue({ total: hits.length, hits: [...hits] }),
+ id: tableId,
+ });
+ });
+
+ const { component, table } = testBed!;
+ component.update();
+ const { tableCellsValues } = table.getMetaData('itemsInMemTable');
+ expect(tableCellsValues.length).toBe(10); // 10 items this time
+ }
+ });
});
describe('column sorting', () => {
diff --git a/packages/content-management/table_list_view_table/src/table_list_view_table.tsx b/packages/content-management/table_list_view_table/src/table_list_view_table.tsx
index 1fe5123d54151..c7653c668f0df 100644
--- a/packages/content-management/table_list_view_table/src/table_list_view_table.tsx
+++ b/packages/content-management/table_list_view_table/src/table_list_view_table.tsx
@@ -43,6 +43,7 @@ import {
ContentInsightsProvider,
useContentInsightsServices,
} from '@kbn/content-management-content-insights-public';
+import { useEuiTablePersist } from '@kbn/shared-ux-table-persist';
import {
Table,
@@ -443,7 +444,7 @@ function TableListViewTableComp({
hasUpdatedAtMetadata,
hasCreatedByMetadata,
hasRecentlyAccessedMetadata,
- pagination,
+ pagination: _pagination,
tableSort,
tableFilter,
} = state;
@@ -903,7 +904,7 @@ function TableListViewTableComp({
[updateTableSortFilterAndPagination]
);
- const onTableChange = useCallback(
+ const customOnTableChange = useCallback(
(criteria: CriteriaWithPagination) => {
const data: {
sort?: State['tableSort'];
@@ -1038,6 +1039,20 @@ function TableListViewTableComp({
);
}, [entityName, fetchError]);
+ const { pageSize, onTableChange } = useEuiTablePersist({
+ tableId: listingId,
+ initialPageSize,
+ customOnTableChange,
+ pageSizeOptions: uniq([10, 20, 50, initialPageSize]).sort(),
+ });
+
+ const pagination = useMemo(() => {
+ return {
+ ..._pagination,
+ pageSize,
+ };
+ }, [_pagination, pageSize]);
+
// ------------
// Effects
// ------------
diff --git a/packages/content-management/table_list_view_table/tsconfig.json b/packages/content-management/table_list_view_table/tsconfig.json
index a5530ee717e49..90a96953570fb 100644
--- a/packages/content-management/table_list_view_table/tsconfig.json
+++ b/packages/content-management/table_list_view_table/tsconfig.json
@@ -37,7 +37,9 @@
"@kbn/content-management-user-profiles",
"@kbn/recently-accessed",
"@kbn/content-management-content-insights-public",
- "@kbn/content-management-favorites-public"
+ "@kbn/content-management-favorites-public",
+ "@kbn/kibana-utils-plugin",
+ "@kbn/shared-ux-table-persist"
],
"exclude": [
"target/**/*"
diff --git a/packages/core/application/core-application-browser-internal/src/application_service.test.ts b/packages/core/application/core-application-browser-internal/src/application_service.test.ts
index 8cd9a61923240..13b2317605ad0 100644
--- a/packages/core/application/core-application-browser-internal/src/application_service.test.ts
+++ b/packages/core/application/core-application-browser-internal/src/application_service.test.ts
@@ -26,14 +26,14 @@ import { themeServiceMock } from '@kbn/core-theme-browser-mocks';
import { overlayServiceMock } from '@kbn/core-overlays-browser-mocks';
import { customBrandingServiceMock } from '@kbn/core-custom-branding-browser-mocks';
import { analyticsServiceMock } from '@kbn/core-analytics-browser-mocks';
-import { MockLifecycle } from './test_helpers/test_types';
+import type { MockLifecycle } from './test_helpers/test_types';
import { ApplicationService } from './application_service';
import {
- App,
- AppDeepLink,
+ type App,
+ type AppDeepLink,
AppStatus,
- AppUpdater,
- PublicAppInfo,
+ type AppUpdater,
+ type PublicAppInfo,
} from '@kbn/core-application-browser';
import { act } from 'react-dom/test-utils';
import { DEFAULT_APP_VISIBILITY } from './utils';
@@ -618,6 +618,26 @@ describe('#start()', () => {
});
});
+ describe('isAppRegistered', () => {
+ let isAppRegistered: any;
+ beforeEach(async () => {
+ const { register } = service.setup(setupDeps);
+ register(Symbol(), createApp({ id: 'one_app' }));
+ register(Symbol(), createApp({ id: 'another_app', appRoute: '/custom/path' }));
+
+ const start = await service.start(startDeps);
+ isAppRegistered = start.isAppRegistered;
+ });
+
+ it('returns false for unregistered apps', () => {
+ expect(isAppRegistered('oneApp')).toEqual(false);
+ });
+
+ it('returns true for registered apps', () => {
+ expect(isAppRegistered('another_app')).toEqual(true);
+ });
+ });
+
describe('getUrlForApp', () => {
it('creates URL for unregistered appId', async () => {
service.setup(setupDeps);
diff --git a/packages/core/application/core-application-browser-internal/src/application_service.tsx b/packages/core/application/core-application-browser-internal/src/application_service.tsx
index 8c4bf16f6dff6..678b74f95265e 100644
--- a/packages/core/application/core-application-browser-internal/src/application_service.tsx
+++ b/packages/core/application/core-application-browser-internal/src/application_service.tsx
@@ -327,6 +327,9 @@ export class ApplicationService {
takeUntil(this.stop$)
),
history: this.history!,
+ isAppRegistered: (appId: string): boolean => {
+ return applications$.value.get(appId) !== undefined;
+ },
getUrlForApp: (
appId,
{
diff --git a/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts b/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts
index fe50fe3733496..a0bc498de94c4 100644
--- a/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts
+++ b/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts
@@ -51,6 +51,7 @@ const createStartContractMock = (): jest.Mocked => {
navigateToApp: jest.fn(),
navigateToUrl: jest.fn(),
getUrlForApp: jest.fn(),
+ isAppRegistered: jest.fn(),
};
};
@@ -92,6 +93,7 @@ const createInternalStartContractMock = (
currentActionMenu$: new BehaviorSubject(undefined),
getComponent: jest.fn(),
getUrlForApp: jest.fn(),
+ isAppRegistered: jest.fn(),
navigateToApp: jest.fn().mockImplementation((appId) => currentAppId$.next(appId)),
navigateToUrl: jest.fn(),
history: createHistoryMock(),
diff --git a/packages/core/application/core-application-browser/src/contracts.ts b/packages/core/application/core-application-browser/src/contracts.ts
index 9f10bb1206c97..e8b2cd77028f6 100644
--- a/packages/core/application/core-application-browser/src/contracts.ts
+++ b/packages/core/application/core-application-browser/src/contracts.ts
@@ -68,9 +68,12 @@ export interface ApplicationStart {
applications$: Observable>;
/**
- * Navigate to a given app
+ * Navigate to a given app.
+ * If a plugin is disabled any applications it registers won't be available either.
+ * Before rendering a UI element that a user could use to navigate to another application,
+ * first check if the destination application is actually available using the isAppRegistered API.
*
- * @param appId
+ * @param appId - The identifier of the app to navigate to
* @param options - navigation options
*/
navigateToApp(appId: string, options?: NavigateToAppOptions): Promise;
@@ -114,6 +117,14 @@ export interface ApplicationStart {
*/
navigateToUrl(url: string, options?: NavigateToUrlOptions): Promise;
+ /**
+ * Checks whether a given application is registered.
+ *
+ * @param appId - The identifier of the app to check
+ * @returns true if the given appId is registered in the system, false otherwise.
+ */
+ isAppRegistered(appId: string): boolean;
+
/**
* Returns the absolute path (or URL) to a given app, including the global base path.
*
diff --git a/packages/core/apps/core-apps-browser-internal/src/status/components/status_table.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/status_table.test.tsx
index 38d69311d741e..b9949a6decf44 100644
--- a/packages/core/apps/core-apps-browser-internal/src/status/components/status_table.test.tsx
+++ b/packages/core/apps/core-apps-browser-internal/src/status/components/status_table.test.tsx
@@ -9,7 +9,7 @@
import React from 'react';
import { shallow } from 'enzyme';
-import type { StatusInfoServiceStatus as ServiceStatus } from '@kbn/core-status-common-internal';
+import type { StatusInfoServiceStatus as ServiceStatus } from '@kbn/core-status-common';
import { StatusTable } from './status_table';
const state = {
diff --git a/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.test.tsx
index 62e48467ae51f..6180860df780d 100644
--- a/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.test.tsx
+++ b/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.test.tsx
@@ -9,7 +9,7 @@
import React from 'react';
import { mountWithIntl, findTestSubject } from '@kbn/test-jest-helpers';
-import type { ServerVersion } from '@kbn/core-status-common-internal';
+import type { ServerVersion } from '@kbn/core-status-common';
import { VersionHeader } from './version_header';
const buildServerVersion = (parts: Partial = {}): ServerVersion => ({
diff --git a/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.tsx
index 0dc64a3cb7db0..15c1f9d07a273 100644
--- a/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.tsx
+++ b/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.tsx
@@ -10,7 +10,7 @@
import React, { FC } from 'react';
import { EuiFlexGroup, EuiFlexItem, EuiPanel, EuiText } from '@elastic/eui';
import { FormattedMessage } from '@kbn/i18n-react';
-import type { ServerVersion } from '@kbn/core-status-common-internal';
+import type { ServerVersion } from '@kbn/core-status-common';
interface VersionHeaderProps {
version: ServerVersion;
diff --git a/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts
index a63c5011dcaf8..c37db930de789 100644
--- a/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts
+++ b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts
@@ -8,7 +8,7 @@
*/
import { httpServiceMock } from '@kbn/core-http-browser-mocks';
-import type { StatusResponse } from '@kbn/core-status-common-internal';
+import type { StatusResponse } from '@kbn/core-status-common';
import { notificationServiceMock } from '@kbn/core-notifications-browser-mocks';
import { mocked } from '@kbn/core-metrics-collectors-server-mocks';
import { loadStatus } from './load_status';
diff --git a/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts
index f89e2196d2122..e8519030c3fdf 100644
--- a/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts
+++ b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts
@@ -11,11 +11,11 @@ import numeral from '@elastic/numeral';
import { i18n } from '@kbn/i18n';
import type { HttpSetup } from '@kbn/core-http-browser';
import type { NotificationsSetup } from '@kbn/core-notifications-browser';
-import type { ServiceStatusLevelId } from '@kbn/core-status-common';
import type {
+ ServiceStatusLevelId,
StatusResponse,
StatusInfoServiceStatus as ServiceStatus,
-} from '@kbn/core-status-common-internal';
+} from '@kbn/core-status-common';
import type { DataType } from './format_number';
interface MetricMeta {
diff --git a/packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.test.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.test.ts
index 3d393bd8e4719..290845c4bdd08 100644
--- a/packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.test.ts
+++ b/packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.test.ts
@@ -7,7 +7,7 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-import type { StatusInfoServiceStatus as ServiceStatus } from '@kbn/core-status-common-internal';
+import type { StatusInfoServiceStatus as ServiceStatus } from '@kbn/core-status-common';
import { getLevelSortValue, groupByLevel, getHighestStatus } from './status_level';
import { FormattedStatus, StatusState } from './load_status';
diff --git a/packages/core/apps/core-apps-browser-internal/tsconfig.json b/packages/core/apps/core-apps-browser-internal/tsconfig.json
index a18bb3421a1f4..9902b12732760 100644
--- a/packages/core/apps/core-apps-browser-internal/tsconfig.json
+++ b/packages/core/apps/core-apps-browser-internal/tsconfig.json
@@ -24,7 +24,6 @@
"@kbn/core-application-browser",
"@kbn/core-application-browser-internal",
"@kbn/core-mount-utils-browser-internal",
- "@kbn/core-status-common-internal",
"@kbn/core-http-browser-internal",
"@kbn/core-application-browser-mocks",
"@kbn/core-notifications-browser-mocks",
diff --git a/packages/core/base/core-base-common/BUILD.bazel b/packages/core/base/core-base-common/BUILD.bazel
new file mode 100644
index 0000000000000..30c3b1ae616f4
--- /dev/null
+++ b/packages/core/base/core-base-common/BUILD.bazel
@@ -0,0 +1,35 @@
+load("@build_bazel_rules_nodejs//:index.bzl", "js_library")
+
+SRCS = glob(
+ [
+ "**/*.ts",
+ "**/*.tsx",
+ ],
+ exclude = [
+ "**/test_helpers.ts",
+ "**/*.config.js",
+ "**/*.mock.*",
+ "**/*.test.*",
+ "**/*.stories.*",
+ "**/__snapshots__/**",
+ "**/integration_tests/**",
+ "**/mocks/**",
+ "**/scripts/**",
+ "**/storybook/**",
+ "**/test_fixtures/**",
+ "**/test_helpers/**",
+ ],
+)
+
+DEPS = [
+ "@npm//react",
+ "@npm//tslib",
+]
+
+js_library(
+ name = "core-base-common",
+ package_name = "@kbn/core-base-common",
+ srcs = ["package.json"] + SRCS,
+ deps = DEPS,
+ visibility = ["//visibility:public"],
+)
diff --git a/packages/core/injected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts b/packages/core/injected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts
index 804134cabd4b9..68fa84022ce34 100644
--- a/packages/core/injected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts
+++ b/packages/core/injected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts
@@ -57,6 +57,7 @@ const createSetupContractMock = () => {
setupContract.getPlugins.mockReturnValue([]);
setupContract.getTheme.mockReturnValue({
darkMode: false,
+ name: 'amsterdam',
version: 'v8',
stylesheetPaths: {
default: ['light-1.css'],
diff --git a/packages/core/injected-metadata/core-injected-metadata-common-internal/src/types.ts b/packages/core/injected-metadata/core-injected-metadata-common-internal/src/types.ts
index 1ee75dbfc0d5d..e988420720900 100644
--- a/packages/core/injected-metadata/core-injected-metadata-common-internal/src/types.ts
+++ b/packages/core/injected-metadata/core-injected-metadata-common-internal/src/types.ts
@@ -41,6 +41,7 @@ export interface InjectedMetadataExternalUrlPolicy {
/** @internal */
export interface InjectedMetadataTheme {
darkMode: DarkModeValue;
+ name: string;
version: ThemeVersion;
stylesheetPaths: {
default: string[];
diff --git a/packages/core/logging/core-logging-common-internal/src/layouts/conversions/date.ts b/packages/core/logging/core-logging-common-internal/src/layouts/conversions/date.ts
index 53dadaafde667..e78ba6b62a7e3 100644
--- a/packages/core/logging/core-logging-common-internal/src/layouts/conversions/date.ts
+++ b/packages/core/logging/core-logging-common-internal/src/layouts/conversions/date.ts
@@ -12,7 +12,7 @@ import { last } from 'lodash';
import { LogRecord } from '@kbn/logging';
import { Conversion } from './types';
-const dateRegExp = /%date({(?[^}]+)})?({(?[^}]+)})?/g;
+const dateRegExp = /%date(?:\{(?[^}]+)\})?(?:\{(?[A-Za-z/_+-]+)\})?/g;
const formats = {
ISO8601: 'ISO8601',
@@ -29,7 +29,6 @@ function formatDate(
): string {
const momentDate = moment(date);
momentDate.tz(timezone ?? moment.tz.guess());
-
switch (dateFormat) {
case formats.ISO8601:
return momentDate.toISOString();
diff --git a/packages/core/logging/core-logging-server-internal/src/layouts/pattern_layout.test.ts b/packages/core/logging/core-logging-server-internal/src/layouts/pattern_layout.test.ts
index 2965703eda5d7..53409a5851bd6 100644
--- a/packages/core/logging/core-logging-server-internal/src/layouts/pattern_layout.test.ts
+++ b/packages/core/logging/core-logging-server-internal/src/layouts/pattern_layout.test.ts
@@ -326,6 +326,21 @@ describe('schema', () => {
`"Date format expected one of ISO8601, ISO8601_TZ, ABSOLUTE, UNIX, UNIX_MILLIS, but given: HH"`
);
});
+
+ it('fails on %date with schema too long', () => {
+ const generateLongFormat = () => {
+ const longFormat = [];
+ for (let i = 1; i < 1001; i++) {
+ longFormat.push(`${i}`);
+ }
+ return longFormat.join('');
+ };
+ expect(() =>
+ patternSchema.validate(`%date${generateLongFormat()}`)
+ ).toThrowErrorMatchingInlineSnapshot(
+ `"value has length [2898] but it must have a maximum length of [1000]."`
+ );
+ });
});
});
});
diff --git a/packages/core/logging/core-logging-server-internal/src/layouts/pattern_layout.ts b/packages/core/logging/core-logging-server-internal/src/layouts/pattern_layout.ts
index d4ee822b27f93..758dcc65af637 100644
--- a/packages/core/logging/core-logging-server-internal/src/layouts/pattern_layout.ts
+++ b/packages/core/logging/core-logging-server-internal/src/layouts/pattern_layout.ts
@@ -24,6 +24,7 @@ import {
const DEFAULT_PATTERN = `[%date][%level][%logger] %message`;
export const patternSchema = schema.string({
+ maxLength: 1000,
validate: (string) => {
DateConversion.validate!(string);
},
diff --git a/packages/core/plugins/core-plugins-browser-internal/src/plugin_context.ts b/packages/core/plugins/core-plugins-browser-internal/src/plugin_context.ts
index b78e5cec0b276..cdd00d9996a40 100644
--- a/packages/core/plugins/core-plugins-browser-internal/src/plugin_context.ts
+++ b/packages/core/plugins/core-plugins-browser-internal/src/plugin_context.ts
@@ -143,6 +143,7 @@ export function createPluginStartContext<
navigateToApp: deps.application.navigateToApp,
navigateToUrl: deps.application.navigateToUrl,
getUrlForApp: deps.application.getUrlForApp,
+ isAppRegistered: deps.application.isAppRegistered,
currentLocation$: deps.application.currentLocation$,
},
customBranding: deps.customBranding,
diff --git a/packages/core/rendering/core-rendering-browser-internal/src/rendering_service.tsx b/packages/core/rendering/core-rendering-browser-internal/src/rendering_service.tsx
index 700dad544cd2b..12a597ba9318f 100644
--- a/packages/core/rendering/core-rendering-browser-internal/src/rendering_service.tsx
+++ b/packages/core/rendering/core-rendering-browser-internal/src/rendering_service.tsx
@@ -18,6 +18,7 @@ import type { I18nStart } from '@kbn/core-i18n-browser';
import type { OverlayStart } from '@kbn/core-overlays-browser';
import type { ThemeServiceStart } from '@kbn/core-theme-browser';
import { KibanaRootContextProvider } from '@kbn/react-kibana-context-root';
+import { APP_FIXED_VIEWPORT_ID } from '@kbn/core-rendering-browser';
import { AppWrapper } from './app_containers';
interface StartServices {
@@ -68,7 +69,7 @@ export class RenderingService {
{/* The App Wrapper outside of the fixed headers that accepts custom class names from apps */}
{/* Affixes a div to restrict the position of charts tooltip to the visible viewport minus the header */}
-
+
{/* The actual plugin/app */}
{appComponent}
diff --git a/packages/core/rendering/core-rendering-browser-internal/tsconfig.json b/packages/core/rendering/core-rendering-browser-internal/tsconfig.json
index 42c59f96b2471..4b0c009a0a033 100644
--- a/packages/core/rendering/core-rendering-browser-internal/tsconfig.json
+++ b/packages/core/rendering/core-rendering-browser-internal/tsconfig.json
@@ -26,7 +26,8 @@
"@kbn/core-analytics-browser-mocks",
"@kbn/core-analytics-browser",
"@kbn/core-i18n-browser",
- "@kbn/core-theme-browser"
+ "@kbn/core-theme-browser",
+ "@kbn/core-rendering-browser"
],
"exclude": [
"target/**/*",
diff --git a/packages/core/rendering/core-rendering-browser/README.md b/packages/core/rendering/core-rendering-browser/README.md
new file mode 100644
index 0000000000000..40141d7611e72
--- /dev/null
+++ b/packages/core/rendering/core-rendering-browser/README.md
@@ -0,0 +1,4 @@
+# @kbn/core-rendering-browser
+
+This package contains the types and implementation for Core's browser-side rendering service.
+
diff --git a/src/plugins/discover/public/context_awareness/profile_providers/common/logs_data_source_profile/index.ts b/packages/core/rendering/core-rendering-browser/index.ts
similarity index 84%
rename from src/plugins/discover/public/context_awareness/profile_providers/common/logs_data_source_profile/index.ts
rename to packages/core/rendering/core-rendering-browser/index.ts
index 43465810bd334..d8ccea264df05 100644
--- a/src/plugins/discover/public/context_awareness/profile_providers/common/logs_data_source_profile/index.ts
+++ b/packages/core/rendering/core-rendering-browser/index.ts
@@ -7,4 +7,4 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-export { createLogsDataSourceProfileProviders } from './create_profile_providers';
+export { APP_FIXED_VIEWPORT_ID, useAppFixedViewport } from './src';
diff --git a/packages/core/status/core-status-common-internal/jest.config.js b/packages/core/rendering/core-rendering-browser/jest.config.js
similarity index 88%
rename from packages/core/status/core-status-common-internal/jest.config.js
rename to packages/core/rendering/core-rendering-browser/jest.config.js
index bc848cd656199..13f1819553812 100644
--- a/packages/core/status/core-status-common-internal/jest.config.js
+++ b/packages/core/rendering/core-rendering-browser/jest.config.js
@@ -10,5 +10,5 @@
module.exports = {
preset: '@kbn/test',
rootDir: '../../../..',
- roots: ['/packages/core/status/core-status-common-internal'],
+ roots: ['/packages/core/rendering/core-rendering-browser'],
};
diff --git a/packages/core/rendering/core-rendering-browser/kibana.jsonc b/packages/core/rendering/core-rendering-browser/kibana.jsonc
new file mode 100644
index 0000000000000..4b43c11865134
--- /dev/null
+++ b/packages/core/rendering/core-rendering-browser/kibana.jsonc
@@ -0,0 +1,5 @@
+{
+ "type": "shared-browser",
+ "id": "@kbn/core-rendering-browser",
+ "owner": "@elastic/kibana-core"
+}
diff --git a/packages/core/status/core-status-common-internal/package.json b/packages/core/rendering/core-rendering-browser/package.json
similarity index 74%
rename from packages/core/status/core-status-common-internal/package.json
rename to packages/core/rendering/core-rendering-browser/package.json
index d2c456b6dc96a..4f1fa6f68ef01 100644
--- a/packages/core/status/core-status-common-internal/package.json
+++ b/packages/core/rendering/core-rendering-browser/package.json
@@ -1,5 +1,5 @@
{
- "name": "@kbn/core-status-common-internal",
+ "name": "@kbn/core-rendering-browser",
"private": true,
"version": "1.0.0",
"author": "Kibana Core",
diff --git a/packages/core/rendering/core-rendering-browser/src/index.ts b/packages/core/rendering/core-rendering-browser/src/index.ts
new file mode 100644
index 0000000000000..aad756d296561
--- /dev/null
+++ b/packages/core/rendering/core-rendering-browser/src/index.ts
@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export { APP_FIXED_VIEWPORT_ID, useAppFixedViewport } from './use_app_fixed_viewport';
diff --git a/src/plugins/presentation_util/common/lib/utils/default_theme.ts b/packages/core/rendering/core-rendering-browser/src/use_app_fixed_viewport.ts
similarity index 66%
rename from src/plugins/presentation_util/common/lib/utils/default_theme.ts
rename to packages/core/rendering/core-rendering-browser/src/use_app_fixed_viewport.ts
index 9c86456bc2513..ecf44a0018b49 100644
--- a/src/plugins/presentation_util/common/lib/utils/default_theme.ts
+++ b/packages/core/rendering/core-rendering-browser/src/use_app_fixed_viewport.ts
@@ -7,9 +7,11 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-import type { CoreTheme } from '@kbn/core/public';
-import { Observable } from 'rxjs';
+import { useRef } from 'react';
-export const defaultTheme$: Observable = new Observable((subscriber) =>
- subscriber.next({ darkMode: false })
-);
+export const APP_FIXED_VIEWPORT_ID = 'app-fixed-viewport';
+
+export function useAppFixedViewport() {
+ const ref = useRef(document.getElementById(APP_FIXED_VIEWPORT_ID) ?? undefined);
+ return ref.current;
+}
diff --git a/packages/core/status/core-status-common-internal/tsconfig.json b/packages/core/rendering/core-rendering-browser/tsconfig.json
similarity index 65%
rename from packages/core/status/core-status-common-internal/tsconfig.json
rename to packages/core/rendering/core-rendering-browser/tsconfig.json
index 7d31fa090eb0f..3a932605dfa75 100644
--- a/packages/core/status/core-status-common-internal/tsconfig.json
+++ b/packages/core/rendering/core-rendering-browser/tsconfig.json
@@ -4,18 +4,15 @@
"outDir": "target/types",
"types": [
"jest",
- "node"
+ "node",
+ "react"
]
},
"include": [
"**/*.ts",
"**/*.tsx",
],
- "kbn_references": [
- "@kbn/core-status-common",
- "@kbn/core-metrics-server",
- "@kbn/config"
- ],
+ "kbn_references": [],
"exclude": [
"target/**/*",
]
diff --git a/packages/core/rendering/core-rendering-server-internal/src/__snapshots__/rendering_service.test.ts.snap b/packages/core/rendering/core-rendering-server-internal/src/__snapshots__/rendering_service.test.ts.snap
index c858b6a8470d2..8b1dc7ef53e15 100644
--- a/packages/core/rendering/core-rendering-server-internal/src/__snapshots__/rendering_service.test.ts.snap
+++ b/packages/core/rendering/core-rendering-server-internal/src/__snapshots__/rendering_service.test.ts.snap
@@ -68,6 +68,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -149,6 +150,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -234,6 +236,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -315,6 +318,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -396,6 +400,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -481,6 +486,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -562,6 +568,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -643,6 +650,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -724,6 +732,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -814,6 +823,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -895,6 +905,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -985,6 +996,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -1071,6 +1083,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -1152,6 +1165,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -1242,6 +1256,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -1328,6 +1343,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -1414,6 +1430,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
@@ -1502,6 +1519,7 @@ Object {
"serverBasePath": "/mock-server-basepath",
"theme": Object {
"darkMode": "theme:darkMode",
+ "name": "theme:name",
"stylesheetPaths": Object {
"dark": Array [
"/style-1.css",
diff --git a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts
index 597e4159e4cc7..25d7e241325f3 100644
--- a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts
+++ b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts
@@ -34,6 +34,18 @@ const createPackageInfo = (parts: Partial = {}): PackageInfo => ({
...parts,
});
+const getClientGetMockImplementation =
+ ({ darkMode, name }: { darkMode?: boolean; name?: string } = {}) =>
+ (key: string) => {
+ switch (key) {
+ case 'theme:darkMode':
+ return Promise.resolve(darkMode ?? false);
+ case 'theme:name':
+ return Promise.resolve(name ?? 'amsterdam');
+ }
+ return Promise.resolve();
+ };
+
const createUiPlugins = (): UiPlugins => ({
public: new Map(),
internal: new Map(),
@@ -59,6 +71,7 @@ describe('bootstrapRenderer', () => {
getPluginsBundlePathsMock.mockReturnValue(new Map());
renderTemplateMock.mockReturnValue('__rendered__');
getJsDependencyPathsMock.mockReturnValue([]);
+ uiSettingsClient.get.mockImplementation(getClientGetMockImplementation());
renderer = bootstrapRendererFactory({
auth,
@@ -91,13 +104,17 @@ describe('bootstrapRenderer', () => {
uiSettingsClient,
});
- expect(uiSettingsClient.get).toHaveBeenCalledTimes(1);
+ expect(uiSettingsClient.get).toHaveBeenCalledTimes(2);
expect(uiSettingsClient.get).toHaveBeenCalledWith('theme:darkMode');
+ expect(uiSettingsClient.get).toHaveBeenCalledWith('theme:name');
});
it('calls getThemeTag with the values from the UiSettingsClient (true/dark) when the UserSettingsService is not provided', async () => {
- uiSettingsClient.get.mockResolvedValue(true);
-
+ uiSettingsClient.get.mockImplementation(
+ getClientGetMockImplementation({
+ darkMode: true,
+ })
+ );
const request = httpServerMock.createKibanaRequest();
await renderer({
@@ -107,13 +124,13 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: true,
});
});
it('calls getThemeTag with the values from the UiSettingsClient (false/light) when the UserSettingsService is not provided', async () => {
- uiSettingsClient.get.mockResolvedValue(false);
+ uiSettingsClient.get.mockImplementation(getClientGetMockImplementation({}));
const request = httpServerMock.createKibanaRequest();
@@ -124,7 +141,7 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: false,
});
});
@@ -150,7 +167,7 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: true,
});
});
@@ -166,7 +183,6 @@ describe('bootstrapRenderer', () => {
userSettingsService,
});
- uiSettingsClient.get.mockResolvedValue(true);
const request = httpServerMock.createKibanaRequest();
await renderer({
@@ -176,7 +192,7 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: false,
});
});
@@ -192,7 +208,6 @@ describe('bootstrapRenderer', () => {
userSettingsService,
});
- uiSettingsClient.get.mockResolvedValue(false);
const request = httpServerMock.createKibanaRequest();
await renderer({
@@ -202,7 +217,7 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: false,
});
});
@@ -218,7 +233,11 @@ describe('bootstrapRenderer', () => {
userSettingsService,
});
- uiSettingsClient.get.mockResolvedValue(true);
+ uiSettingsClient.get.mockImplementation(
+ getClientGetMockImplementation({
+ darkMode: true,
+ })
+ );
const request = httpServerMock.createKibanaRequest();
await renderer({
@@ -228,7 +247,7 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: true,
});
});
@@ -250,12 +269,17 @@ describe('bootstrapRenderer', () => {
uiSettingsClient,
});
- expect(uiSettingsClient.get).toHaveBeenCalledTimes(1);
+ expect(uiSettingsClient.get).toHaveBeenCalledTimes(2);
expect(uiSettingsClient.get).toHaveBeenCalledWith('theme:darkMode');
+ expect(uiSettingsClient.get).toHaveBeenCalledWith('theme:name');
});
it('calls getThemeTag with the correct parameters', async () => {
- uiSettingsClient.get.mockResolvedValue(true);
+ uiSettingsClient.get.mockImplementation(
+ getClientGetMockImplementation({
+ darkMode: true,
+ })
+ );
const request = httpServerMock.createKibanaRequest();
@@ -266,7 +290,7 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: true,
});
});
@@ -283,7 +307,7 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'system',
darkMode: false,
});
});
@@ -318,7 +342,7 @@ describe('bootstrapRenderer', () => {
expect(getThemeTagMock).toHaveBeenCalledTimes(1);
expect(getThemeTagMock).toHaveBeenCalledWith({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: false,
});
});
diff --git a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.ts b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.ts
index 8aa0d2a6c0387..5b8c267532d0b 100644
--- a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.ts
+++ b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.ts
@@ -9,7 +9,6 @@
import { createHash } from 'crypto';
import { PackageInfo } from '@kbn/config';
-import { ThemeVersion } from '@kbn/ui-shared-deps-npm';
import type { KibanaRequest, HttpAuth } from '@kbn/core-http-server';
import { type DarkModeValue, parseDarkModeValue } from '@kbn/core-ui-settings-common';
import type { IUiSettingsClient } from '@kbn/core-ui-settings-server';
@@ -59,7 +58,7 @@ export const bootstrapRendererFactory: BootstrapRendererFactory = ({
return async function bootstrapRenderer({ uiSettingsClient, request, isAnonymousPage = false }) {
let darkMode: DarkModeValue = false;
- const themeVersion: ThemeVersion = 'v8';
+ let themeName: string = 'amsterdam';
try {
const authenticated = isAuthenticated(request);
@@ -72,6 +71,8 @@ export const bootstrapRendererFactory: BootstrapRendererFactory = ({
} else {
darkMode = parseDarkModeValue(await uiSettingsClient.get('theme:darkMode'));
}
+
+ themeName = await uiSettingsClient.get('theme:name');
}
} catch (e) {
// just use the default values in case of connectivity issues with ES
@@ -83,7 +84,7 @@ export const bootstrapRendererFactory: BootstrapRendererFactory = ({
}
const themeTag = getThemeTag({
- themeVersion,
+ name: !themeName || themeName === 'amsterdam' ? 'v8' : themeName,
darkMode,
});
const bundlesHref = getBundlesHref(baseHref);
diff --git a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/get_theme_tag.test.ts b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/get_theme_tag.test.ts
index 0f9839e8cda89..216e87269818b 100644
--- a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/get_theme_tag.test.ts
+++ b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/get_theme_tag.test.ts
@@ -10,18 +10,18 @@
import { getThemeTag } from './get_theme_tag';
describe('getThemeTag', () => {
- it('returns the correct value for version:v8 and darkMode:false', () => {
+ it('returns the correct value for name:v8 and darkMode:false', () => {
expect(
getThemeTag({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: false,
})
).toEqual('v8light');
});
- it('returns the correct value for version:v8 and darkMode:true', () => {
+ it('returns the correct value for name:v8 and darkMode:true', () => {
expect(
getThemeTag({
- themeVersion: 'v8',
+ name: 'v8',
darkMode: true,
})
).toEqual('v8dark');
diff --git a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/get_theme_tag.ts b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/get_theme_tag.ts
index 97f5c17ef240b..f89bd41404633 100644
--- a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/get_theme_tag.ts
+++ b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/get_theme_tag.ts
@@ -7,18 +7,10 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-import type { ThemeVersion } from '@kbn/ui-shared-deps-npm';
-
/**
* Computes the themeTag that will be used on the client-side as `__kbnThemeTag__`
* @see `packages/kbn-ui-shared-deps-src/theme.ts`
*/
-export const getThemeTag = ({
- themeVersion,
- darkMode,
-}: {
- themeVersion: ThemeVersion;
- darkMode: boolean;
-}) => {
- return `${themeVersion}${darkMode ? 'dark' : 'light'}`;
+export const getThemeTag = ({ name, darkMode }: { name: string; darkMode: boolean }) => {
+ return `${name}${darkMode ? 'dark' : 'light'}`;
};
diff --git a/packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx b/packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx
index ace0399f242af..a92c3dac485b5 100644
--- a/packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx
+++ b/packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx
@@ -22,6 +22,7 @@ import type { CustomBranding } from '@kbn/core-custom-branding-common';
import {
type DarkModeValue,
parseDarkModeValue,
+ parseThemeNameValue,
type UiSettingsParams,
type UserProvidedValues,
} from '@kbn/core-ui-settings-common';
@@ -211,6 +212,8 @@ export class RenderingService {
darkMode = getSettingValue('theme:darkMode', settings, parseDarkModeValue);
}
+ const themeName = getSettingValue('theme:name', settings, parseThemeNameValue);
+
const themeStylesheetPaths = (mode: boolean) =>
getThemeStylesheetPaths({
darkMode: mode,
@@ -274,6 +277,7 @@ export class RenderingService {
},
theme: {
darkMode,
+ name: themeName,
version: themeVersion,
stylesheetPaths: {
default: themeStylesheetPaths(false),
diff --git a/packages/core/rendering/core-rendering-server-internal/src/views/styles.tsx b/packages/core/rendering/core-rendering-server-internal/src/views/styles.tsx
index ceeb6f4b7f9e2..54e8559ad25c1 100644
--- a/packages/core/rendering/core-rendering-server-internal/src/views/styles.tsx
+++ b/packages/core/rendering/core-rendering-server-internal/src/views/styles.tsx
@@ -8,17 +8,18 @@
*/
import React, { FC } from 'react';
-import type { DarkModeValue } from '@kbn/core-ui-settings-common';
+import { type DarkModeValue, ThemeName } from '@kbn/core-ui-settings-common';
interface Props {
darkMode: DarkModeValue;
+ themeName: ThemeName;
stylesheetPaths: string[];
}
-export const Styles: FC = ({ darkMode, stylesheetPaths }) => {
+export const Styles: FC = ({ darkMode, themeName, stylesheetPaths }) => {
return (
<>
- {darkMode !== 'system' && }
+ {darkMode !== 'system' && }
{stylesheetPaths.map((path) => (
))}
@@ -26,7 +27,27 @@ export const Styles: FC = ({ darkMode, stylesheetPaths }) => {
);
};
-const InlineStyles: FC<{ darkMode: boolean }> = ({ darkMode }) => {
+const InlineStyles: FC<{ darkMode: boolean; themeName: ThemeName }> = ({ darkMode, themeName }) => {
+ const getThemeStyles = (theme: ThemeName) => {
+ if (theme === 'borealis') {
+ return {
+ pageBackground: darkMode ? '#07101F' : '#F6F9FC', // colors.body
+ welcomeText: darkMode ? '#8E9FBC' : '#5A6D8C', // colors.subduedText
+ progress: darkMode ? '#172336' : '#ECF1F9', // colors.lightestShade
+ progressBefore: darkMode ? '#599DFF' : '#0B64DD', // colors.primary
+ };
+ }
+
+ return {
+ pageBackground: darkMode ? '#141519' : '#F8FAFD',
+ welcomeText: darkMode ? '#98A2B3' : '#69707D',
+ progress: darkMode ? '#25262E' : '#F5F7FA',
+ progressBefore: darkMode ? '#1BA9F5' : '#006DE4',
+ };
+ };
+
+ const themeStyles = getThemeStyles(themeName);
+
// must be kept in sync with
// packages/core/apps/core-apps-server-internal/assets/legacy_theme.js
/* eslint-disable react/no-danger */
@@ -36,19 +57,19 @@ const InlineStyles: FC<{ darkMode: boolean }> = ({ darkMode }) => {
__html: `
html {
- background-color: ${darkMode ? '#141519' : '#F8FAFD'}
+ background-color: ${themeStyles.pageBackground}
}
.kbnWelcomeText {
- color: ${darkMode ? '#98A2B3' : '#69707D'};
+ color: ${themeStyles.welcomeText};
}
.kbnProgress {
- background-color: ${darkMode ? '#25262E' : '#F5F7FA'};
+ background-color: ${themeStyles.progress};
}
.kbnProgress:before {
- background-color: ${darkMode ? '#1BA9F5' : '#006DE4'};
+ background-color: ${themeStyles.progressBefore};
}
`,
diff --git a/packages/core/rendering/core-rendering-server-internal/src/views/template.tsx b/packages/core/rendering/core-rendering-server-internal/src/views/template.tsx
index fdbade121445d..d3556287a0333 100644
--- a/packages/core/rendering/core-rendering-server-internal/src/views/template.tsx
+++ b/packages/core/rendering/core-rendering-server-internal/src/views/template.tsx
@@ -56,7 +56,11 @@ export const Template: FunctionComponent = ({
{/* Inject EUI reset and global styles before all other component styles */}
-
+
{scriptPaths.map((path) => (
))}
diff --git a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/lib/validate_references.test.ts b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/lib/validate_references.test.ts
index 3702b46fdd790..6e3198f153df1 100644
--- a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/lib/validate_references.test.ts
+++ b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/lib/validate_references.test.ts
@@ -267,4 +267,36 @@ describe('validateReferences()', () => {
'Error fetching references for imported objects'
);
});
+
+ // test that when references are missing returns only deduplicated errors
+ test('returns only deduplicated errors when references are missing', async () => {
+ const params = setup({
+ objects: [
+ {
+ id: '2',
+ type: 'visualization',
+ attributes: { title: 'My Visualization 2' },
+ references: [
+ { name: 'ref_0', type: 'index-pattern', id: '3' },
+ { name: 'ref_0', type: 'index-pattern', id: '3' },
+ ],
+ },
+ ],
+ });
+ params.savedObjectsClient.bulkGet.mockResolvedValue({
+ saved_objects: [createNotFoundError({ type: 'index-pattern', id: '3' })],
+ });
+
+ const result = await validateReferences(params);
+ expect(result).toEqual([
+ expect.objectContaining({
+ type: 'visualization',
+ id: '2',
+ error: {
+ type: 'missing_references',
+ references: [{ type: 'index-pattern', id: '3' }],
+ },
+ }),
+ ]);
+ });
});
diff --git a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/lib/validate_references.ts b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/lib/validate_references.ts
index e83fafe3348f7..b482bceb8ae0a 100644
--- a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/lib/validate_references.ts
+++ b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/lib/validate_references.ts
@@ -102,30 +102,35 @@ export async function validateReferences(params: ValidateReferencesParams) {
const nonExistingReferenceKeys = await getNonExistingReferenceAsKeys(params);
// Filter out objects with missing references, add to error object
- objects.forEach(({ type, id, references, attributes }) => {
- if (objectsToSkip.has(`${type}:${id}`)) {
+ for (const obj of objects) {
+ const { type, id, references, attributes } = obj;
+ const objectKey = `${type}:${id}`;
+ if (objectsToSkip.has(objectKey)) {
// skip objects with retries that have specified `ignoreMissingReferences`
- return;
+ continue;
}
- const missingReferences = [];
- const enforcedTypeReferences = (references || []).filter(filterReferencesToValidate);
+ const missingReferences: Array<{ type: string; id: string }> = [];
+ const enforcedTypeReferences = references?.filter(filterReferencesToValidate) || [];
+
+ const seenReferences = new Set();
for (const { type: refType, id: refId } of enforcedTypeReferences) {
- if (nonExistingReferenceKeys.includes(`${refType}:${refId}`)) {
+ const refKey = `${refType}:${refId}`;
+
+ if (nonExistingReferenceKeys.includes(refKey) && !seenReferences.has(refKey)) {
missingReferences.push({ type: refType, id: refId });
+ seenReferences.add(refKey);
}
}
- if (missingReferences.length === 0) {
- return;
+ if (missingReferences.length > 0) {
+ errorMap[objectKey] = {
+ id,
+ type,
+ meta: { title: attributes.title },
+ error: { type: 'missing_references', references: missingReferences },
+ };
}
- const { title } = attributes;
- errorMap[`${type}:${id}`] = {
- id,
- type,
- meta: { title },
- error: { type: 'missing_references', references: missingReferences },
- };
- });
+ }
return Object.values(errorMap);
}
diff --git a/packages/core/security/core-security-server-internal/src/fips/fips.test.ts b/packages/core/security/core-security-server-internal/src/fips/fips.test.ts
index ff610493e1322..724f6accd5204 100644
--- a/packages/core/security/core-security-server-internal/src/fips/fips.test.ts
+++ b/packages/core/security/core-security-server-internal/src/fips/fips.test.ts
@@ -25,26 +25,26 @@ import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
describe('fips', () => {
let securityConfig: SecurityServiceConfigType;
describe('#isFipsEnabled', () => {
- it('should return `true` if config.experimental.fipsMode.enabled is `true`', () => {
- securityConfig = { experimental: { fipsMode: { enabled: true } } };
+ it('should return `true` if config.fipsMode.enabled is `true`', () => {
+ securityConfig = { fipsMode: { enabled: true } };
expect(isFipsEnabled(securityConfig)).toBe(true);
});
- it('should return `false` if config.experimental.fipsMode.enabled is `false`', () => {
- securityConfig = { experimental: { fipsMode: { enabled: false } } };
+ it('should return `false` if config.fipsMode.enabled is `false`', () => {
+ securityConfig = { fipsMode: { enabled: false } };
expect(isFipsEnabled(securityConfig)).toBe(false);
});
- it('should return `false` if config.experimental.fipsMode.enabled is `undefined`', () => {
+ it('should return `false` if config.fipsMode.enabled is `undefined`', () => {
expect(isFipsEnabled(securityConfig)).toBe(false);
});
});
describe('checkFipsConfig', () => {
- it('should log an error message if FIPS mode is misconfigured - xpack.security.experimental.fipsMode.enabled true, Nodejs FIPS mode false', async () => {
- securityConfig = { experimental: { fipsMode: { enabled: true } } };
+ it('should log an error message if FIPS mode is misconfigured - xpack.security.fipsMode.enabled true, Nodejs FIPS mode false', async () => {
+ securityConfig = { fipsMode: { enabled: true } };
const logger = loggingSystemMock.create().get();
let fipsException: undefined | CriticalError;
try {
@@ -56,16 +56,16 @@ describe('fips', () => {
expect(fipsException).toBeInstanceOf(CriticalError);
expect(fipsException!.processExitCode).toBe(78);
expect(fipsException!.message).toEqual(
- 'Configuration mismatch error. xpack.security.experimental.fipsMode.enabled is set to true and the configured Node.js environment has FIPS disabled'
+ 'Configuration mismatch error. xpack.security.fipsMode.enabled is set to true and the configured Node.js environment has FIPS disabled'
);
});
- it('should log an error message if FIPS mode is misconfigured - xpack.security.experimental.fipsMode.enabled false, Nodejs FIPS mode true', async () => {
+ it('should log an error message if FIPS mode is misconfigured - xpack.security.fipsMode.enabled false, Nodejs FIPS mode true', async () => {
mockGetFipsFn.mockImplementationOnce(() => {
return 1;
});
- securityConfig = { experimental: { fipsMode: { enabled: false } } };
+ securityConfig = { fipsMode: { enabled: false } };
const logger = loggingSystemMock.create().get();
let fipsException: undefined | CriticalError;
@@ -77,16 +77,16 @@ describe('fips', () => {
expect(fipsException).toBeInstanceOf(CriticalError);
expect(fipsException!.processExitCode).toBe(78);
expect(fipsException!.message).toEqual(
- 'Configuration mismatch error. xpack.security.experimental.fipsMode.enabled is set to false and the configured Node.js environment has FIPS enabled'
+ 'Configuration mismatch error. xpack.security.fipsMode.enabled is set to false and the configured Node.js environment has FIPS enabled'
);
});
- it('should log an info message if FIPS mode is properly configured - xpack.security.experimental.fipsMode.enabled true, Nodejs FIPS mode true', async () => {
+ it('should log an info message if FIPS mode is properly configured - xpack.security.fipsMode.enabled true, Nodejs FIPS mode true', async () => {
mockGetFipsFn.mockImplementationOnce(() => {
return 1;
});
- securityConfig = { experimental: { fipsMode: { enabled: true } } };
+ securityConfig = { fipsMode: { enabled: true } };
const logger = loggingSystemMock.create().get();
try {
@@ -113,7 +113,7 @@ describe('fips', () => {
return 1;
});
- securityConfig = { experimental: { fipsMode: { enabled: true } } };
+ securityConfig = { fipsMode: { enabled: true } };
});
afterEach(function () {
diff --git a/packages/core/security/core-security-server-internal/src/fips/fips.ts b/packages/core/security/core-security-server-internal/src/fips/fips.ts
index 0d9dea9e467fe..5fa47d3afc062 100644
--- a/packages/core/security/core-security-server-internal/src/fips/fips.ts
+++ b/packages/core/security/core-security-server-internal/src/fips/fips.ts
@@ -12,7 +12,7 @@ import { getFips } from 'crypto';
import { CriticalError } from '@kbn/core-base-server-internal';
import { PKCS12ConfigType, SecurityServiceConfigType } from '../utils';
export function isFipsEnabled(config: SecurityServiceConfigType): boolean {
- return config?.experimental?.fipsMode?.enabled ?? false;
+ return config?.fipsMode?.enabled ?? false;
}
export function checkFipsConfig(
@@ -33,7 +33,7 @@ export function checkFipsConfig(
// FIPS must be enabled on both, or, log/error an exit Kibana
if (isFipsConfigEnabled !== isNodeRunningWithFipsEnabled) {
throw new CriticalError(
- `Configuration mismatch error. xpack.security.experimental.fipsMode.enabled is set to ${isFipsConfigEnabled} and the configured Node.js environment has FIPS ${
+ `Configuration mismatch error. xpack.security.fipsMode.enabled is set to ${isFipsConfigEnabled} and the configured Node.js environment has FIPS ${
isNodeRunningWithFipsEnabled ? 'enabled' : 'disabled'
}`,
'invalidConfig',
diff --git a/packages/core/security/core-security-server-internal/src/security_service.test.ts b/packages/core/security/core-security-server-internal/src/security_service.test.ts
index 75539e9954ac0..d725d062b231e 100644
--- a/packages/core/security/core-security-server-internal/src/security_service.test.ts
+++ b/packages/core/security/core-security-server-internal/src/security_service.test.ts
@@ -16,17 +16,30 @@ import { loggerMock, MockedLogger } from '@kbn/logging-mocks';
import { mockCoreContext } from '@kbn/core-base-server-mocks';
import type { CoreSecurityDelegateContract } from '@kbn/core-security-server';
import { SecurityService } from './security_service';
+import { configServiceMock } from '@kbn/config-mocks';
+import { getFips } from 'crypto';
const createStubInternalContract = (): CoreSecurityDelegateContract => {
return Symbol('stubContract') as unknown as CoreSecurityDelegateContract;
};
-describe('SecurityService', () => {
+describe('SecurityService', function () {
let coreContext: ReturnType;
+ let configService: ReturnType;
let service: SecurityService;
beforeEach(() => {
- coreContext = mockCoreContext.create();
+ const mockConfig = {
+ xpack: {
+ security: {
+ fipsMode: {
+ enabled: !!getFips(),
+ },
+ },
+ },
+ };
+ configService = configServiceMock.create({ getConfig$: mockConfig });
+ coreContext = mockCoreContext.create({ configService });
service = new SecurityService(coreContext);
convertSecurityApiMock.mockReset();
@@ -51,8 +64,11 @@ describe('SecurityService', () => {
describe('#isEnabled', () => {
it('should return boolean', () => {
const { fips } = service.setup();
-
- expect(fips.isEnabled()).toBe(false);
+ if (getFips() === 0) {
+ expect(fips.isEnabled()).toBe(false);
+ } else {
+ expect(fips.isEnabled()).toBe(true);
+ }
});
});
});
diff --git a/packages/core/security/core-security-server-internal/src/utils/index.ts b/packages/core/security/core-security-server-internal/src/utils/index.ts
index 666afcce38afd..ad4ed95e685ee 100644
--- a/packages/core/security/core-security-server-internal/src/utils/index.ts
+++ b/packages/core/security/core-security-server-internal/src/utils/index.ts
@@ -11,10 +11,8 @@ export { convertSecurityApi } from './convert_security_api';
export { getDefaultSecurityImplementation } from './default_implementation';
export interface SecurityServiceConfigType {
- experimental?: {
- fipsMode?: {
- enabled: boolean;
- };
+ fipsMode?: {
+ enabled: boolean;
};
}
diff --git a/packages/core/security/core-security-server-internal/tsconfig.json b/packages/core/security/core-security-server-internal/tsconfig.json
index e1812dc77cf49..11128461daf4e 100644
--- a/packages/core/security/core-security-server-internal/tsconfig.json
+++ b/packages/core/security/core-security-server-internal/tsconfig.json
@@ -22,5 +22,6 @@
"@kbn/core-base-server-mocks",
"@kbn/config",
"@kbn/core-logging-server-mocks",
+ "@kbn/config-mocks",
]
}
diff --git a/packages/core/status/core-status-common-internal/README.md b/packages/core/status/core-status-common-internal/README.md
deleted file mode 100644
index f4e4af7fd3b3a..0000000000000
--- a/packages/core/status/core-status-common-internal/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# @kbn/core-status-common-internal
-
-This package contains the common internal types for Core's `status` domain.
diff --git a/packages/core/status/core-status-common-internal/kibana.jsonc b/packages/core/status/core-status-common-internal/kibana.jsonc
deleted file mode 100644
index 20ce17ae3cefa..0000000000000
--- a/packages/core/status/core-status-common-internal/kibana.jsonc
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "type": "shared-common",
- "id": "@kbn/core-status-common-internal",
- "owner": "@elastic/kibana-core"
-}
diff --git a/packages/core/status/core-status-common/index.ts b/packages/core/status/core-status-common/index.ts
index 50eb85608522e..1aae83558016a 100644
--- a/packages/core/status/core-status-common/index.ts
+++ b/packages/core/status/core-status-common/index.ts
@@ -7,5 +7,14 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-export { ServiceStatusLevels } from './src';
-export type { ServiceStatus, ServiceStatusLevel, ServiceStatusLevelId, CoreStatus } from './src';
+export { ServiceStatusLevels } from './src/service_status';
+export type { CoreStatus } from './src/core_status';
+export type { ServiceStatus, ServiceStatusLevel, ServiceStatusLevelId } from './src/service_status';
+export type {
+ StatusInfo,
+ StatusInfoCoreStatus,
+ StatusInfoServiceStatus,
+ StatusResponse,
+ ServerVersion,
+ ServerMetrics,
+} from './src/status';
diff --git a/packages/core/status/core-status-common/jest.config.js b/packages/core/status/core-status-common/jest.config.js
index bc848cd656199..48ce844bb7d3f 100644
--- a/packages/core/status/core-status-common/jest.config.js
+++ b/packages/core/status/core-status-common/jest.config.js
@@ -10,5 +10,5 @@
module.exports = {
preset: '@kbn/test',
rootDir: '../../../..',
- roots: ['/packages/core/status/core-status-common-internal'],
+ roots: ['/packages/core/status/core-status-common'],
};
diff --git a/packages/core/status/core-status-common/src/index.ts b/packages/core/status/core-status-common/src/index.ts
deleted file mode 100644
index 7cfcc7dbf79a8..0000000000000
--- a/packages/core/status/core-status-common/src/index.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the "Elastic License
- * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
- * Public License v 1"; you may not use this file except in compliance with, at
- * your election, the "Elastic License 2.0", the "GNU Affero General Public
- * License v3.0 only", or the "Server Side Public License, v 1".
- */
-
-export { ServiceStatusLevels } from './service_status';
-export type { ServiceStatus, ServiceStatusLevel, ServiceStatusLevelId } from './service_status';
-export type { CoreStatus } from './core_status';
diff --git a/packages/core/status/core-status-common-internal/src/status.ts b/packages/core/status/core-status-common/src/status.ts
similarity index 92%
rename from packages/core/status/core-status-common-internal/src/status.ts
rename to packages/core/status/core-status-common/src/status.ts
index 370d2c9ac6e5d..7c981c56ceeb3 100644
--- a/packages/core/status/core-status-common-internal/src/status.ts
+++ b/packages/core/status/core-status-common/src/status.ts
@@ -8,8 +8,9 @@
*/
import type { BuildFlavor } from '@kbn/config';
-import type { ServiceStatusLevelId, ServiceStatus, CoreStatus } from '@kbn/core-status-common';
import type { OpsMetrics } from '@kbn/core-metrics-server';
+import type { ServiceStatusLevelId, ServiceStatus } from './service_status';
+import type { CoreStatus } from './core_status';
export interface StatusInfoServiceStatus extends Omit {
level: ServiceStatusLevelId;
diff --git a/packages/core/status/core-status-common/tsconfig.json b/packages/core/status/core-status-common/tsconfig.json
index a63f70f93043d..3b61a574a06bb 100644
--- a/packages/core/status/core-status-common/tsconfig.json
+++ b/packages/core/status/core-status-common/tsconfig.json
@@ -12,7 +12,9 @@
"**/*.tsx",
],
"kbn_references": [
- "@kbn/std"
+ "@kbn/std",
+ "@kbn/config",
+ "@kbn/core-metrics-server"
],
"exclude": [
"target/**/*",
diff --git a/packages/core/status/core-status-server-internal/src/routes/status.ts b/packages/core/status/core-status-server-internal/src/routes/status.ts
index 87e0e6e745a92..bafda87c2b08d 100644
--- a/packages/core/status/core-status-server-internal/src/routes/status.ts
+++ b/packages/core/status/core-status-server-internal/src/routes/status.ts
@@ -15,7 +15,7 @@ import type { IRouter } from '@kbn/core-http-server';
import type { MetricsServiceSetup } from '@kbn/core-metrics-server';
import type { CoreIncrementUsageCounter } from '@kbn/core-usage-data-server';
import { type ServiceStatus, type CoreStatus, ServiceStatusLevels } from '@kbn/core-status-common';
-import { StatusResponse } from '@kbn/core-status-common-internal';
+import type { StatusResponse } from '@kbn/core-status-common';
import { calculateLegacyStatus, type LegacyStatusInfo } from '../legacy_status';
import { statusResponse, type RedactedStatusHttpBody } from './status_response_schemas';
diff --git a/packages/core/status/core-status-server-internal/src/routes/status_response_schemas.ts b/packages/core/status/core-status-server-internal/src/routes/status_response_schemas.ts
index a2dcbcf7d21b6..68cebab4392e0 100644
--- a/packages/core/status/core-status-server-internal/src/routes/status_response_schemas.ts
+++ b/packages/core/status/core-status-server-internal/src/routes/status_response_schemas.ts
@@ -9,15 +9,15 @@
import { schema, type Type, type TypeOf } from '@kbn/config-schema';
import type { BuildFlavor } from '@kbn/config';
-import type { ServiceStatusLevelId, ServiceStatus } from '@kbn/core-status-common';
-
import type {
+ ServiceStatusLevelId,
+ ServiceStatus,
StatusResponse,
StatusInfoCoreStatus,
ServerMetrics,
StatusInfo,
ServerVersion,
-} from '@kbn/core-status-common-internal';
+} from '@kbn/core-status-common';
const serviceStatusLevelId: () => Type = () =>
schema.oneOf(
diff --git a/packages/core/status/core-status-server-internal/tsconfig.json b/packages/core/status/core-status-server-internal/tsconfig.json
index bda646809e414..5ca46556cac33 100644
--- a/packages/core/status/core-status-server-internal/tsconfig.json
+++ b/packages/core/status/core-status-server-internal/tsconfig.json
@@ -29,7 +29,6 @@
"@kbn/core-saved-objects-server-internal",
"@kbn/core-status-server",
"@kbn/core-status-common",
- "@kbn/core-status-common-internal",
"@kbn/core-usage-data-base-server-internal",
"@kbn/core-base-server-mocks",
"@kbn/core-environment-server-mocks",
diff --git a/packages/core/test-helpers/core-test-helpers-kbn-server/src/create_root.ts b/packages/core/test-helpers/core-test-helpers-kbn-server/src/create_root.ts
index d2fa6850a8bf8..0ec20dca7db8d 100644
--- a/packages/core/test-helpers/core-test-helpers-kbn-server/src/create_root.ts
+++ b/packages/core/test-helpers/core-test-helpers-kbn-server/src/create_root.ts
@@ -12,10 +12,12 @@ import loadJsonFile from 'load-json-file';
import { defaultsDeep } from 'lodash';
import { BehaviorSubject } from 'rxjs';
import supertest from 'supertest';
+import { set } from '@kbn/safer-lodash-set';
import { getPackages } from '@kbn/repo-packages';
import { ToolingLog } from '@kbn/tooling-log';
import { REPO_ROOT } from '@kbn/repo-info';
+import { getFips } from 'crypto';
import {
createTestEsCluster,
CreateTestEsClusterOptions,
@@ -75,6 +77,17 @@ export function createRootWithSettings(
pkg.version = customKibanaVersion;
}
+ /*
+ * Most of these integration tests expect OSS to default to true, but FIPS
+ * requires the security plugin to be enabled
+ */
+ let oss = true;
+ if (getFips() === 1) {
+ set(settings, 'xpack.security.fipsMode.enabled', true);
+ oss = false;
+ delete cliArgs.oss;
+ }
+
const env = Env.createDefault(
REPO_ROOT,
{
@@ -84,10 +97,10 @@ export function createRootWithSettings(
watch: false,
basePath: false,
runExamples: false,
- oss: true,
disableOptimizer: true,
cache: true,
dist: false,
+ oss,
...cliArgs,
},
repoPackages: getPackages(REPO_ROOT),
@@ -255,7 +268,13 @@ export function createTestServers({
if (!adjustTimeout) {
throw new Error('adjustTimeout is required in order to avoid flaky tests');
}
- const license = settings.es?.license ?? 'basic';
+ let license = settings.es?.license ?? 'basic';
+
+ if (getFips() === 1) {
+ // Set license to 'trial' if Node is running in FIPS mode
+ license = 'trial';
+ }
+
const usersToBeAdded = settings.users ?? [];
if (usersToBeAdded.length > 0) {
if (license !== 'trial') {
@@ -292,6 +311,7 @@ export function createTestServers({
hosts: es.getHostUrls(),
username: kibanaServerTestUser.username,
password: kibanaServerTestUser.password,
+ ...(getFips() ? kbnSettings.elasticsearch : {}),
};
}
diff --git a/packages/core/test-helpers/core-test-helpers-kbn-server/tsconfig.json b/packages/core/test-helpers/core-test-helpers-kbn-server/tsconfig.json
index 85d14bb04ab59..65ca0ccdfca0b 100644
--- a/packages/core/test-helpers/core-test-helpers-kbn-server/tsconfig.json
+++ b/packages/core/test-helpers/core-test-helpers-kbn-server/tsconfig.json
@@ -20,6 +20,7 @@
"@kbn/repo-packages",
"@kbn/es",
"@kbn/dev-utils",
+ "@kbn/safer-lodash-set",
],
"exclude": [
"target/**/*",
diff --git a/packages/core/theme/core-theme-browser-internal/src/core_theme_provider.test.tsx b/packages/core/theme/core-theme-browser-internal/src/core_theme_provider.test.tsx
index 3f4aebe797172..a3e4516b07510 100644
--- a/packages/core/theme/core-theme-browser-internal/src/core_theme_provider.test.tsx
+++ b/packages/core/theme/core-theme-browser-internal/src/core_theme_provider.test.tsx
@@ -50,7 +50,7 @@ describe('CoreThemeProvider', () => {
};
it('exposes the EUI theme provider', async () => {
- const coreTheme: CoreTheme = { darkMode: true };
+ const coreTheme: CoreTheme = { darkMode: true, name: 'amsterdam' };
const wrapper = mountWithIntl(
@@ -64,7 +64,7 @@ describe('CoreThemeProvider', () => {
});
it('propagates changes of the coreTheme observable', async () => {
- const coreTheme$ = new BehaviorSubject({ darkMode: true });
+ const coreTheme$ = new BehaviorSubject({ darkMode: true, name: 'amsterdam' });
const wrapper = mountWithIntl(
@@ -77,7 +77,7 @@ describe('CoreThemeProvider', () => {
expect(euiTheme!.colorMode).toEqual('DARK');
await act(async () => {
- coreTheme$.next({ darkMode: false });
+ coreTheme$.next({ darkMode: false, name: 'amsterdam' });
});
await refresh(wrapper);
diff --git a/packages/core/theme/core-theme-browser-internal/src/theme_service.test.ts b/packages/core/theme/core-theme-browser-internal/src/theme_service.test.ts
index 45c90d90d522a..575d98fe40c8d 100644
--- a/packages/core/theme/core-theme-browser-internal/src/theme_service.test.ts
+++ b/packages/core/theme/core-theme-browser-internal/src/theme_service.test.ts
@@ -45,6 +45,7 @@ describe('ThemeService', () => {
beforeEach(() => {
injectedMetadata.getTheme.mockReturnValue({
version: 'v8',
+ name: 'amsterdam',
darkMode: false,
stylesheetPaths: {
dark: ['dark-1.css'],
@@ -58,6 +59,7 @@ describe('ThemeService', () => {
const theme = await firstValueFrom(theme$);
expect(theme).toEqual({
darkMode: false,
+ name: 'amsterdam',
});
});
@@ -88,6 +90,7 @@ describe('ThemeService', () => {
beforeEach(() => {
injectedMetadata.getTheme.mockReturnValue({
version: 'v8',
+ name: 'amsterdam',
darkMode: true,
stylesheetPaths: {
dark: ['dark-1.css'],
@@ -101,6 +104,7 @@ describe('ThemeService', () => {
const theme = await firstValueFrom(theme$);
expect(theme).toEqual({
darkMode: true,
+ name: 'amsterdam',
});
});
@@ -131,6 +135,7 @@ describe('ThemeService', () => {
beforeEach(() => {
injectedMetadata.getTheme.mockReturnValue({
version: 'v8',
+ name: 'amsterdam',
darkMode: 'system',
stylesheetPaths: {
dark: ['dark-1.css'],
@@ -150,6 +155,7 @@ describe('ThemeService', () => {
expect(theme).toEqual({
darkMode: false,
+ name: 'amsterdam',
});
expect(window.__kbnThemeTag__).toEqual('v8light');
@@ -177,6 +183,7 @@ describe('ThemeService', () => {
expect(theme).toEqual({
darkMode: false,
+ name: 'amsterdam',
});
expect(window.__kbnThemeTag__).toEqual('v8light');
@@ -196,6 +203,7 @@ describe('ThemeService', () => {
expect(theme).toEqual({
darkMode: true,
+ name: 'amsterdam',
});
expect(window.__kbnThemeTag__).toEqual('v8dark');
@@ -244,6 +252,7 @@ describe('ThemeService', () => {
it('exposes a `theme$` observable with the values provided by the injected metadata', async () => {
injectedMetadata.getTheme.mockReturnValue({
version: 'v8',
+ name: 'amsterdam',
darkMode: true,
stylesheetPaths: {
dark: [],
@@ -255,6 +264,7 @@ describe('ThemeService', () => {
const theme = await firstValueFrom(theme$);
expect(theme).toEqual({
darkMode: true,
+ name: 'amsterdam',
});
});
});
diff --git a/packages/core/theme/core-theme-browser-internal/src/theme_service.ts b/packages/core/theme/core-theme-browser-internal/src/theme_service.ts
index 7bc51c9a0c34a..e79a19550bb8d 100644
--- a/packages/core/theme/core-theme-browser-internal/src/theme_service.ts
+++ b/packages/core/theme/core-theme-browser-internal/src/theme_service.ts
@@ -28,16 +28,21 @@ export class ThemeService {
public setup({ injectedMetadata }: ThemeServiceSetupDeps): ThemeServiceSetup {
const themeMetadata = injectedMetadata.getTheme();
+
this.themeMetadata = themeMetadata;
- let theme: CoreTheme;
+ let darkMode: boolean;
if (themeMetadata.darkMode === 'system' && browsersSupportsSystemTheme()) {
- theme = { darkMode: systemThemeIsDark() };
+ darkMode = systemThemeIsDark();
} else {
- const darkMode = themeMetadata.darkMode === 'system' ? false : themeMetadata.darkMode;
- theme = { darkMode };
+ darkMode = themeMetadata.darkMode === 'system' ? false : themeMetadata.darkMode;
}
+ const theme: CoreTheme = {
+ darkMode,
+ name: themeMetadata.name,
+ };
+
this.applyTheme(theme);
this.contract = {
@@ -73,11 +78,13 @@ export class ThemeService {
});
_setDarkMode(darkMode);
- updateKbnThemeTag(darkMode);
+ updateKbnThemeTag(theme);
}
}
-const updateKbnThemeTag = (darkMode: boolean) => {
+const updateKbnThemeTag = (theme: CoreTheme) => {
+ const name = theme.name === 'amsterdam' ? 'v8' : theme.name;
+
const globals: any = typeof window === 'undefined' ? {} : window;
- globals.__kbnThemeTag__ = darkMode ? 'v8dark' : 'v8light';
+ globals.__kbnThemeTag__ = `${name}${theme.darkMode ? 'dark' : 'light'}`;
};
diff --git a/packages/core/theme/core-theme-browser-mocks/src/theme_service.mock.ts b/packages/core/theme/core-theme-browser-mocks/src/theme_service.mock.ts
index beee2320d7cca..e3d2b66645794 100644
--- a/packages/core/theme/core-theme-browser-mocks/src/theme_service.mock.ts
+++ b/packages/core/theme/core-theme-browser-mocks/src/theme_service.mock.ts
@@ -14,6 +14,7 @@ import type { ThemeService } from '@kbn/core-theme-browser-internal';
const mockTheme: CoreTheme = {
darkMode: false,
+ name: 'amsterdam',
};
const createThemeMock = (): CoreTheme => {
diff --git a/packages/core/theme/core-theme-browser/src/types.ts b/packages/core/theme/core-theme-browser/src/types.ts
index 161758ec362f3..365cde9f814ac 100644
--- a/packages/core/theme/core-theme-browser/src/types.ts
+++ b/packages/core/theme/core-theme-browser/src/types.ts
@@ -17,6 +17,10 @@ import { Observable } from 'rxjs';
export interface CoreTheme {
/** is dark mode enabled or not */
readonly darkMode: boolean;
+ /**
+ * Name of the active theme
+ */
+ readonly name: string;
}
/**
diff --git a/packages/core/ui-settings/core-ui-settings-common/index.ts b/packages/core/ui-settings/core-ui-settings-common/index.ts
index b7adb288008df..d290b9065c546 100644
--- a/packages/core/ui-settings/core-ui-settings-common/index.ts
+++ b/packages/core/ui-settings/core-ui-settings-common/index.ts
@@ -17,5 +17,18 @@ export type {
GetUiSettingsContext,
} from './src/ui_settings';
export { type DarkModeValue, parseDarkModeValue } from './src/dark_mode';
+export {
+ DEFAULT_THEME_TAGS,
+ SUPPORTED_THEME_TAGS,
+ DEFAULT_THEME_NAME,
+ SUPPORTED_THEME_NAMES,
+ FALLBACK_THEME_TAG,
+ parseThemeTags,
+ hasNonDefaultThemeTags,
+ parseThemeNameValue,
+ type ThemeName,
+ type ThemeTag,
+ type ThemeTags,
+} from './src/theme';
export { TIMEZONE_OPTIONS } from './src/timezones';
diff --git a/packages/core/ui-settings/core-ui-settings-common/src/theme.ts b/packages/core/ui-settings/core-ui-settings-common/src/theme.ts
new file mode 100644
index 0000000000000..73b465d5b192f
--- /dev/null
+++ b/packages/core/ui-settings/core-ui-settings-common/src/theme.ts
@@ -0,0 +1,102 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export const DEFAULT_THEME_NAME = 'amsterdam';
+export const SUPPORTED_THEME_NAMES = ['amsterdam', 'borealis'];
+
+export type ThemeName = (typeof SUPPORTED_THEME_NAMES)[number];
+
+/**
+ * Theme tags of the Amsterdam theme
+ */
+export const ThemeAmsterdamTags = ['v8light', 'v8dark'] as const;
+
+/**
+ * Theme tags of the experimental Borealis theme
+ */
+export const ThemeBorealisTags = ['borealislight', 'borealisdark'] as const;
+
+/**
+ * An array of all theme tags supported by Kibana. Note that this list doesn't
+ * reflect what theme tags are available in a Kibana build.
+ */
+export const SUPPORTED_THEME_TAGS = [...ThemeAmsterdamTags, ...ThemeBorealisTags] as const;
+
+export type ThemeTag = (typeof SUPPORTED_THEME_TAGS)[number];
+export type ThemeTags = readonly ThemeTag[];
+
+/**
+ * An array of theme tags available in Kibana by default when not customized
+ * using KBN_OPTIMIZER_THEMES environment variable.
+ */
+export const DEFAULT_THEME_TAGS: ThemeTags = ThemeAmsterdamTags;
+
+export const FALLBACK_THEME_TAG: ThemeTag = 'v8light';
+
+const isValidTag = (tag: unknown) =>
+ SUPPORTED_THEME_TAGS.includes(tag as (typeof SUPPORTED_THEME_TAGS)[number]);
+
+export function parseThemeTags(input?: unknown): ThemeTags {
+ if (!input) {
+ return DEFAULT_THEME_TAGS;
+ }
+
+ if (input === '*') {
+ // TODO: Replace with SUPPORTED_THEME_TAGS when Borealis is in public beta
+ return DEFAULT_THEME_TAGS;
+ }
+
+ // TODO: remove when Borealis is in public beta
+ if (input === 'experimental') {
+ return SUPPORTED_THEME_TAGS;
+ }
+
+ let rawTags: string[];
+ if (typeof input === 'string') {
+ rawTags = input.split(',').map((tag) => tag.trim());
+ } else if (Array.isArray(input)) {
+ rawTags = input;
+ } else {
+ throw new Error('Invalid theme tags, must be an array of strings');
+ }
+
+ if (!rawTags.length) {
+ throw new Error(
+ `Invalid theme tags, you must specify at least one of [${SUPPORTED_THEME_TAGS.join(', ')}]`
+ );
+ }
+
+ const invalidTags = rawTags.filter((t) => !isValidTag(t));
+ if (invalidTags.length) {
+ throw new Error(
+ `Invalid theme tags [${invalidTags.join(', ')}], options: [${SUPPORTED_THEME_TAGS.join(
+ ', '
+ )}]`
+ );
+ }
+
+ return rawTags as ThemeTags;
+}
+
+export const hasNonDefaultThemeTags = (tags: ThemeTags) =>
+ tags.length !== DEFAULT_THEME_TAGS.length ||
+ tags.some((tag) => !DEFAULT_THEME_TAGS.includes(tag as (typeof DEFAULT_THEME_TAGS)[number]));
+
+export const parseThemeNameValue = (value: unknown): ThemeName => {
+ if (typeof value !== 'string') {
+ return DEFAULT_THEME_NAME;
+ }
+
+ const themeName = value.toLowerCase();
+ if (SUPPORTED_THEME_NAMES.includes(themeName.toLowerCase() as ThemeName)) {
+ return themeName as ThemeName;
+ }
+
+ return DEFAULT_THEME_NAME;
+};
diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.ts
index f74977af04b8b..093b4eef9a6de 100644
--- a/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.ts
+++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.ts
@@ -18,6 +18,7 @@ import { getAnnouncementsSettings } from './announcements';
interface GetCoreSettingsOptions {
isDist?: boolean;
+ isThemeSwitcherEnabled?: boolean;
}
export const getCoreSettings = (
diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.ts
index 5701694f97abc..36324f951952e 100644
--- a/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.ts
+++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.ts
@@ -10,15 +10,11 @@
import { schema } from '@kbn/config-schema';
import { i18n } from '@kbn/i18n';
import type { ThemeVersion } from '@kbn/ui-shared-deps-npm';
-import type { UiSettingsParams } from '@kbn/core-ui-settings-common';
-
-function parseThemeTags() {
- if (!process.env.KBN_OPTIMIZER_THEMES || process.env.KBN_OPTIMIZER_THEMES === '*') {
- return ['v8light', 'v8dark'];
- }
-
- return process.env.KBN_OPTIMIZER_THEMES.split(',').map((t) => t.trim());
-}
+import {
+ type UiSettingsParams,
+ parseThemeTags,
+ SUPPORTED_THEME_NAMES,
+} from '@kbn/core-ui-settings-common';
function getThemeInfo(options: GetThemeSettingsOptions) {
if (options?.isDist ?? true) {
@@ -27,7 +23,7 @@ function getThemeInfo(options: GetThemeSettingsOptions) {
};
}
- const themeTags = parseThemeTags();
+ const themeTags = parseThemeTags(process.env.KBN_OPTIMIZER_THEMES);
return {
defaultDarkMode: themeTags[0].endsWith('dark'),
};
@@ -35,6 +31,7 @@ function getThemeInfo(options: GetThemeSettingsOptions) {
interface GetThemeSettingsOptions {
isDist?: boolean;
+ isThemeSwitcherEnabled?: boolean;
}
export const getThemeSettings = (
@@ -89,5 +86,34 @@ export const getThemeSettings = (
readonly: true,
schema: schema.literal('v8'),
},
+ /**
+ * Theme name is the (upcoming) replacement for theme versions.
+ */
+ 'theme:name': {
+ name: i18n.translate('core.ui_settings.params.themeName', {
+ defaultMessage: 'Theme',
+ }),
+ type: 'select',
+ options: SUPPORTED_THEME_NAMES,
+ optionLabels: {
+ amsterdam: i18n.translate('core.ui_settings.params.themeName.options.amsterdam', {
+ defaultMessage: 'Amsterdam',
+ }),
+ borealis: i18n.translate('core.ui_settings.params.themeName.options.borealis', {
+ defaultMessage: 'Borealis',
+ }),
+ },
+ value: 'amsterdam',
+ readonly: Object.hasOwn(options, 'isThemeSwitcherEnabled')
+ ? !options.isThemeSwitcherEnabled
+ : true,
+ requiresPageReload: true,
+ schema: schema.oneOf([
+ schema.literal('amsterdam'),
+ schema.literal('borealis'),
+ // Allow experimental themes
+ schema.string(),
+ ]),
+ },
};
};
diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts
index 6563ffff78949..04b7ff6b0f558 100644
--- a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts
+++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts
@@ -19,6 +19,11 @@ const deprecations: ConfigDeprecationProvider = ({ unused, renameFromRoot }) =>
const configSchema = schema.object({
overrides: schema.object({}, { unknowns: 'allow' }),
publicApiEnabled: offeringBasedSchema({ serverless: schema.boolean({ defaultValue: false }) }),
+ experimental: schema.maybe(
+ schema.object({
+ themeSwitcherEnabled: schema.maybe(schema.boolean({ defaultValue: false })),
+ })
+ ),
});
export type UiSettingsConfigType = TypeOf;
diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts
index 958391b5fc725..70c880c85594f 100644
--- a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts
+++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts
@@ -68,10 +68,15 @@ export class UiSettingsService
public async preboot(): Promise {
this.log.debug('Prebooting ui settings service');
- const { overrides } = await firstValueFrom(this.config$);
+ const { overrides, experimental } = await firstValueFrom(this.config$);
this.overrides = overrides;
- this.register(getCoreSettings({ isDist: this.isDist }));
+ this.register(
+ getCoreSettings({
+ isDist: this.isDist,
+ isThemeSwitcherEnabled: experimental?.themeSwitcherEnabled,
+ })
+ );
return {
createDefaultsClient: () =>
diff --git a/packages/deeplinks/search/constants.ts b/packages/deeplinks/search/constants.ts
index 52f7bb201388e..6d9f6492abda7 100644
--- a/packages/deeplinks/search/constants.ts
+++ b/packages/deeplinks/search/constants.ts
@@ -16,6 +16,7 @@ export const ENTERPRISE_SEARCH_APPSEARCH_APP_ID = 'appSearch';
export const ENTERPRISE_SEARCH_WORKPLACESEARCH_APP_ID = 'workplaceSearch';
export const SERVERLESS_ES_APP_ID = 'serverlessElasticsearch';
export const SERVERLESS_ES_CONNECTORS_ID = 'serverlessConnectors';
+export const SERVERLESS_ES_WEB_CRAWLERS_ID = 'serverlessWebCrawlers';
export const SERVERLESS_ES_SEARCH_PLAYGROUND_ID = 'searchPlayground';
export const SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID = 'searchInferenceEndpoints';
export const SEARCH_HOMEPAGE = 'searchHomepage';
diff --git a/packages/deeplinks/search/deep_links.ts b/packages/deeplinks/search/deep_links.ts
index b23a86b3cc51c..9dc9a8ed18203 100644
--- a/packages/deeplinks/search/deep_links.ts
+++ b/packages/deeplinks/search/deep_links.ts
@@ -10,6 +10,7 @@
import {
SERVERLESS_ES_APP_ID,
SERVERLESS_ES_CONNECTORS_ID,
+ SERVERLESS_ES_WEB_CRAWLERS_ID,
ENTERPRISE_SEARCH_APP_ID,
ENTERPRISE_SEARCH_CONTENT_APP_ID,
ENTERPRISE_SEARCH_APPLICATIONS_APP_ID,
@@ -38,6 +39,7 @@ export type EnterpriseSearchAppsearchApp = typeof ENTERPRISE_SEARCH_APPSEARCH_AP
export type EnterpriseSearchWorkplaceSearchApp = typeof ENTERPRISE_SEARCH_WORKPLACESEARCH_APP_ID;
export type ServerlessSearchApp = typeof SERVERLESS_ES_APP_ID;
export type ConnectorsId = typeof SERVERLESS_ES_CONNECTORS_ID;
+export type ServerlessWebCrawlers = typeof SERVERLESS_ES_WEB_CRAWLERS_ID;
export type SearchPlaygroundId = typeof SERVERLESS_ES_SEARCH_PLAYGROUND_ID;
export type SearchInferenceEndpointsId = typeof SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID;
export type SearchHomepage = typeof SEARCH_HOMEPAGE;
@@ -68,6 +70,7 @@ export type DeepLinkId =
| EnterpriseSearchWorkplaceSearchApp
| ServerlessSearchApp
| ConnectorsId
+ | ServerlessWebCrawlers
| SearchPlaygroundId
| SearchInferenceEndpointsId
| SearchHomepage
diff --git a/packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx b/packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx
index 3f3940e98bf4a..3da86b5f848f7 100644
--- a/packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx
+++ b/packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx
@@ -13,12 +13,13 @@ import {
EuiTabbedContent,
EuiTabbedContentProps,
useEuiOverflowScroll,
+ EuiBasicTableColumn,
} from '@elastic/eui';
import { css } from '@emotion/react';
-import React, { memo, useCallback, useMemo, useState } from 'react';
+import React, { memo, useMemo } from 'react';
import { Alert } from '@kbn/alerting-types';
import { euiThemeVars } from '@kbn/ui-theme';
-import { EuiBasicTableColumn } from '@elastic/eui/src/components/basic_table/basic_table';
+import { useEuiTablePersist } from '@kbn/shared-ux-table-persist';
export const search = {
box: {
@@ -66,28 +67,6 @@ export const ScrollableFlyoutTabbedContent = (props: EuiTabbedContentProps) => (
const COUNT_PER_PAGE_OPTIONS = [25, 50, 100];
-const useFieldBrowserPagination = () => {
- const [pagination, setPagination] = useState<{ pageIndex: number }>({
- pageIndex: 0,
- });
-
- const onTableChange = useCallback(({ page: { index } }: { page: { index: number } }) => {
- setPagination({ pageIndex: index });
- }, []);
- const paginationTableProp = useMemo(
- () => ({
- ...pagination,
- pageSizeOptions: COUNT_PER_PAGE_OPTIONS,
- }),
- [pagination]
- );
-
- return {
- onTableChange,
- paginationTableProp,
- };
-};
-
type AlertField = Exclude<
{
[K in keyof Alert]: { key: K; value: Alert[K] };
@@ -111,7 +90,11 @@ export interface AlertFieldsTableProps {
* A paginated, filterable table to show alert object fields
*/
export const AlertFieldsTable = memo(({ alert, fields }: AlertFieldsTableProps) => {
- const { onTableChange, paginationTableProp } = useFieldBrowserPagination();
+ const { pageSize, sorting, onTableChange } = useEuiTablePersist({
+ tableId: 'obltAlertFields',
+ initialPageSize: 25,
+ });
+
const items = useMemo(() => {
let _items = Object.entries(alert).map(
([key, value]) =>
@@ -131,7 +114,11 @@ export const AlertFieldsTable = memo(({ alert, fields }: AlertFieldsTableProps)
itemId="key"
columns={columns}
onTableChange={onTableChange}
- pagination={paginationTableProp}
+ pagination={{
+ pageSize,
+ pageSizeOptions: COUNT_PER_PAGE_OPTIONS,
+ }}
+ sorting={sorting}
search={search}
css={css`
& .euiTableRow {
diff --git a/packages/kbn-alerts-ui-shared/src/alert_filter_controls/constants.ts b/packages/kbn-alerts-ui-shared/src/alert_filter_controls/constants.ts
index 95606e276362b..c72808d5fceab 100644
--- a/packages/kbn-alerts-ui-shared/src/alert_filter_controls/constants.ts
+++ b/packages/kbn-alerts-ui-shared/src/alert_filter_controls/constants.ts
@@ -70,6 +70,7 @@ export const COMMON_OPTIONS_LIST_CONTROL_INPUTS: Partial any>(cb: T): ReturnType(
optionsOrName: SpanOptions | string,
- cb: (span?: Span) => Promise
+ cb: (span?: Span) => Promise,
+ logger?: Logger
): Promise {
const options = parseSpanOptions(optionsOrName);
const { name, type, subtype, labels, intercept } = options;
+ let time: number | undefined;
+ if (logger?.isLevelEnabled('debug')) {
+ time = performance.now();
+ }
+
+ function logTook(failed: boolean) {
+ if (time) {
+ logger?.debug(
+ () =>
+ `Operation ${name}${failed ? ` (failed)` : ''} ${
+ Math.round(performance.now() - time!) / 1000
+ }s`
+ );
+ }
+ }
+
+ const withLogTook = [
+
(res: TR): TR | Promise
=> {
+ logTook(false);
+ return res;
+ },
+ (err: any): never => {
+ logTook(true);
+ throw err;
+ },
+ ];
+
if (!agent.isStarted()) {
- return cb();
+ const promise = cb();
+ // make sure tests that mock out the callback with a sync
+ // function don't fail.
+ if (typeof promise === 'object' && 'then' in promise) {
+ return promise.then(...withLogTook);
+ }
+ return promise;
}
let createdSpan: Span | undefined;
@@ -57,7 +91,7 @@ export async function withSpan(
createdSpan = agent.startSpan(name) ?? undefined;
if (!createdSpan) {
- return cb();
+ return cb().then(...withLogTook);
}
}
@@ -76,7 +110,7 @@ export async function withSpan(
}
if (!span) {
- return promise;
+ return promise.then(...withLogTook);
}
const targetedSpan = span;
@@ -98,6 +132,7 @@ export async function withSpan(
}
return promise
+ .then(...withLogTook)
.then((res) => {
if (!targetedSpan.outcome || targetedSpan.outcome === 'unknown') {
targetedSpan.outcome = 'success';
diff --git a/packages/kbn-check-mappings-update-cli/current_fields.json b/packages/kbn-check-mappings-update-cli/current_fields.json
index ddb4f90bd22ab..619bdd6c29321 100644
--- a/packages/kbn-check-mappings-update-cli/current_fields.json
+++ b/packages/kbn-check-mappings-update-cli/current_fields.json
@@ -444,6 +444,7 @@
],
"favorites": [
"favoriteIds",
+ "favoriteMetadata",
"type",
"userId"
],
@@ -855,6 +856,13 @@
"policy-settings-protection-updates-note": [
"note"
],
+ "product-doc-install-status": [
+ "index_name",
+ "installation_status",
+ "last_installation_date",
+ "product_name",
+ "product_version"
+ ],
"query": [
"description",
"title",
diff --git a/packages/kbn-check-mappings-update-cli/current_mappings.json b/packages/kbn-check-mappings-update-cli/current_mappings.json
index b7f45eb2acb56..d6ec30393e099 100644
--- a/packages/kbn-check-mappings-update-cli/current_mappings.json
+++ b/packages/kbn-check-mappings-update-cli/current_mappings.json
@@ -1513,6 +1513,10 @@
"favoriteIds": {
"type": "keyword"
},
+ "favoriteMetadata": {
+ "dynamic": false,
+ "type": "object"
+ },
"type": {
"type": "keyword"
},
@@ -2841,6 +2845,26 @@
}
}
},
+ "product-doc-install-status": {
+ "dynamic": false,
+ "properties": {
+ "index_name": {
+ "type": "keyword"
+ },
+ "installation_status": {
+ "type": "keyword"
+ },
+ "last_installation_date": {
+ "type": "date"
+ },
+ "product_name": {
+ "type": "keyword"
+ },
+ "product_version": {
+ "type": "keyword"
+ }
+ }
+ },
"query": {
"dynamic": false,
"properties": {
diff --git a/packages/kbn-doc-links/src/get_doc_links.ts b/packages/kbn-doc-links/src/get_doc_links.ts
index 251d08dde715a..a31e1f1641e8b 100644
--- a/packages/kbn-doc-links/src/get_doc_links.ts
+++ b/packages/kbn-doc-links/src/get_doc_links.ts
@@ -428,6 +428,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
mappingSimilarity: `${ELASTICSEARCH_DOCS}similarity.html`,
mappingSourceFields: `${ELASTICSEARCH_DOCS}mapping-source-field.html`,
mappingSourceFieldsDisable: `${ELASTICSEARCH_DOCS}mapping-source-field.html#disable-source-field`,
+ mappingSyntheticSourceFields: `${ELASTICSEARCH_DOCS}mapping-source-field.html#synthetic-source`,
mappingStore: `${ELASTICSEARCH_DOCS}mapping-store.html`,
mappingSubobjects: `${ELASTICSEARCH_DOCS}subobjects.html`,
mappingTermVector: `${ELASTICSEARCH_DOCS}term-vector.html`,
@@ -470,6 +471,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
securitySolution: {
artifactControl: `${SECURITY_SOLUTION_DOCS}artifact-control.html`,
avcResults: `${ELASTIC_WEBSITE_URL}blog/elastic-av-comparatives-business-security-test`,
+ bidirectionalIntegrations: `${SECURITY_SOLUTION_DOCS}third-party-actions.html`,
trustedApps: `${SECURITY_SOLUTION_DOCS}trusted-apps-ov.html`,
eventFilters: `${SECURITY_SOLUTION_DOCS}event-filters.html`,
blocklist: `${SECURITY_SOLUTION_DOCS}blocklist.html`,
@@ -716,6 +718,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
mappingRoles: `${ELASTICSEARCH_DOCS}mapping-roles.html`,
mappingRolesFieldRules: `${ELASTICSEARCH_DOCS}role-mapping-resources.html#mapping-roles-rule-field`,
runAsPrivilege: `${ELASTICSEARCH_DOCS}security-privileges.html#_run_as_privilege`,
+ deprecatedV1Endpoints: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-199656`,
},
spaces: {
kibanaLegacyUrlAliases: `${KIBANA_DOCS}legacy-url-aliases.html`,
diff --git a/packages/kbn-doc-links/src/types.ts b/packages/kbn-doc-links/src/types.ts
index f1a6a8d4b578d..ac0f66d83b705 100644
--- a/packages/kbn-doc-links/src/types.ts
+++ b/packages/kbn-doc-links/src/types.ts
@@ -340,6 +340,7 @@ export interface DocLinks {
readonly aiAssistant: string;
readonly artifactControl: string;
readonly avcResults: string;
+ readonly bidirectionalIntegrations: string;
readonly trustedApps: string;
readonly eventFilters: string;
readonly eventMerging: string;
@@ -504,6 +505,7 @@ export interface DocLinks {
mappingRoles: string;
mappingRolesFieldRules: string;
runAsPrivilege: string;
+ deprecatedV1Endpoints: string;
}>;
readonly spaces: Readonly<{
kibanaLegacyUrlAliases: string;
diff --git a/packages/kbn-es/src/install/install_source.ts b/packages/kbn-es/src/install/install_source.ts
index 244b349002829..9a7e8f166791a 100644
--- a/packages/kbn-es/src/install/install_source.ts
+++ b/packages/kbn-es/src/install/install_source.ts
@@ -84,7 +84,7 @@ async function sourceInfo(cwd: string, license: string, log: ToolingLog = defaul
log.info('on %s at %s', chalk.bold(branch), chalk.bold(sha));
log.info('%s locally modified file(s)', chalk.bold(status.modified.length));
- const etag = crypto.createHash('md5').update(branch); // eslint-disable-line @kbn/eslint/no_unsafe_hash
+ const etag = crypto.createHash('sha256').update(branch);
etag.update(sha);
// for changed files, use last modified times in hash calculation
@@ -92,7 +92,7 @@ async function sourceInfo(cwd: string, license: string, log: ToolingLog = defaul
etag.update(fs.statSync(path.join(cwd, file.path)).mtime.toString());
});
- const cwdHash = crypto.createHash('md5').update(cwd).digest('hex').substr(0, 8); // eslint-disable-line @kbn/eslint/no_unsafe_hash
+ const cwdHash = crypto.createHash('sha256').update(cwd).digest('hex').substr(0, 8);
const basename = `${branch}-${task}-${cwdHash}`;
const filename = `${basename}.${ext}`;
diff --git a/packages/kbn-es/src/serverless_resources/project_roles/security/roles.yml b/packages/kbn-es/src/serverless_resources/project_roles/security/roles.yml
index 5c8446123a4fb..07016d0f9fd8d 100644
--- a/packages/kbn-es/src/serverless_resources/project_roles/security/roles.yml
+++ b/packages/kbn-es/src/serverless_resources/project_roles/security/roles.yml
@@ -46,7 +46,7 @@ viewer:
- feature_siem.read
- feature_siem.read_alerts
- feature_siem.endpoint_list_read
- - feature_securitySolutionCases.read
+ - feature_securitySolutionCasesV2.read
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.read
@@ -126,7 +126,7 @@ editor:
- feature_siem.process_operations_all
- feature_siem.actions_log_management_all # Response actions history
- feature_siem.file_operations_all
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.read
@@ -175,7 +175,7 @@ t1_analyst:
- feature_siem.read
- feature_siem.read_alerts
- feature_siem.endpoint_list_read
- - feature_securitySolutionCases.read
+ - feature_securitySolutionCasesV2.read
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.read
@@ -230,7 +230,7 @@ t2_analyst:
- feature_siem.read
- feature_siem.read_alerts
- feature_siem.endpoint_list_read
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.read
@@ -300,7 +300,7 @@ t3_analyst:
- feature_siem.actions_log_management_all # Response actions history
- feature_siem.file_operations_all
- feature_siem.scan_operations_all
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.read
@@ -362,7 +362,7 @@ threat_intelligence_analyst:
- feature_siem.all
- feature_siem.endpoint_list_read
- feature_siem.blocklist_all
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.read
@@ -430,7 +430,7 @@ rule_author:
- feature_siem.host_isolation_exceptions_read
- feature_siem.blocklist_all # Elastic Defend Policy Management
- feature_siem.actions_log_management_read
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.read
@@ -502,7 +502,7 @@ soc_manager:
- feature_siem.file_operations_all
- feature_siem.execute_operations_all
- feature_siem.scan_operations_all
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.all
@@ -562,7 +562,7 @@ detections_admin:
- feature_siem.all
- feature_siem.read_alerts
- feature_siem.crud_alerts
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.all
@@ -621,7 +621,7 @@ platform_engineer:
- feature_siem.host_isolation_exceptions_all
- feature_siem.blocklist_all # Elastic Defend Policy Management
- feature_siem.actions_log_management_read
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.all
@@ -694,7 +694,7 @@ endpoint_operations_analyst:
- feature_siem.file_operations_all
- feature_siem.execute_operations_all
- feature_siem.scan_operations_all
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.all
@@ -769,7 +769,7 @@ endpoint_policy_manager:
- feature_siem.event_filters_all
- feature_siem.host_isolation_exceptions_all
- feature_siem.blocklist_all # Elastic Defend Policy Management
- - feature_securitySolutionCases.all
+ - feature_securitySolutionCasesV2.all
- feature_securitySolutionAssistant.all
- feature_securitySolutionAttackDiscovery.all
- feature_actions.all
diff --git a/packages/kbn-es/src/serverless_resources/security_roles.json b/packages/kbn-es/src/serverless_resources/security_roles.json
index 75106ba041d60..424cb898a4f96 100644
--- a/packages/kbn-es/src/serverless_resources/security_roles.json
+++ b/packages/kbn-es/src/serverless_resources/security_roles.json
@@ -35,7 +35,7 @@
"siem": ["read", "read_alerts"],
"securitySolutionAssistant": ["all"],
"securitySolutionAttackDiscovery": ["all"],
- "securitySolutionCases": ["read"],
+ "securitySolutionCasesV2": ["read"],
"actions": ["read"],
"builtInAlerts": ["read"]
},
@@ -82,7 +82,7 @@
"siem": ["read", "read_alerts"],
"securitySolutionAssistant": ["all"],
"securitySolutionAttackDiscovery": ["all"],
- "securitySolutionCases": ["read"],
+ "securitySolutionCasesV2": ["read"],
"actions": ["read"],
"builtInAlerts": ["read"]
},
@@ -150,7 +150,7 @@
"actions_log_management_all",
"file_operations_all"
],
- "securitySolutionCases": ["all"],
+ "securitySolutionCasesV2": ["all"],
"securitySolutionAssistant": ["all"],
"securitySolutionAttackDiscovery": ["all"],
"actions": ["read"],
@@ -210,7 +210,7 @@
"siem": ["all", "read_alerts", "crud_alerts"],
"securitySolutionAssistant": ["all"],
"securitySolutionAttackDiscovery": ["all"],
- "securitySolutionCases": ["all"],
+ "securitySolutionCasesV2": ["all"],
"actions": ["read"],
"builtInAlerts": ["all"]
},
@@ -263,7 +263,7 @@
"siem": ["all", "read_alerts", "crud_alerts"],
"securitySolutionAssistant": ["all"],
"securitySolutionAttackDiscovery": ["all"],
- "securitySolutionCases": ["all"],
+ "securitySolutionCasesV2": ["all"],
"actions": ["all"],
"builtInAlerts": ["all"]
},
@@ -311,7 +311,7 @@
"siem": ["all", "read_alerts", "crud_alerts"],
"securitySolutionAssistant": ["all"],
"securitySolutionAttackDiscovery": ["all"],
- "securitySolutionCases": ["all"],
+ "securitySolutionCasesV2": ["all"],
"actions": ["read"],
"builtInAlerts": ["all"],
"dev_tools": ["all"]
@@ -366,7 +366,7 @@
"siem": ["all", "read_alerts", "crud_alerts"],
"securitySolutionAssistant": ["all"],
"securitySolutionAttackDiscovery": ["all"],
- "securitySolutionCases": ["all"],
+ "securitySolutionCasesV2": ["all"],
"actions": ["all"],
"builtInAlerts": ["all"]
},
diff --git a/packages/kbn-eslint-config/.eslintrc.js b/packages/kbn-eslint-config/.eslintrc.js
index ec39d88606438..e38b6cc48c443 100644
--- a/packages/kbn-eslint-config/.eslintrc.js
+++ b/packages/kbn-eslint-config/.eslintrc.js
@@ -127,13 +127,16 @@ module.exports = {
exclude: USES_STYLED_COMPONENTS,
disallowedMessage: `Prefer using @emotion/react instead. To use styled-components, ensure you plugin is enabled in packages/kbn-babel-preset/styled_components_files.js.`,
},
- ...['@elastic/eui/dist/eui_theme_light.json', '@elastic/eui/dist/eui_theme_dark.json'].map(
- (from) => ({
- from,
- to: false,
- disallowedMessage: `Use "@kbn/ui-theme" to access theme vars.`,
- })
- ),
+ ...[
+ '@elastic/eui/dist/eui_theme_amsterdam_light.json',
+ '@elastic/eui/dist/eui_theme_amsterdam_dark.json',
+ '@elastic/eui/dist/eui_theme_borealis_light.json',
+ '@elastic/eui/dist/eui_theme_borealis_dark.json',
+ ].map((from) => ({
+ from,
+ to: false,
+ disallowedMessage: `Use "@kbn/ui-theme" to access theme vars.`,
+ })),
{
from: '@kbn/test/jest',
to: '@kbn/test-jest-helpers',
diff --git a/packages/kbn-esql-editor/src/editor_footer/discard_starred_query/discard_starred_query_modal.tsx b/packages/kbn-esql-editor/src/editor_footer/discard_starred_query/discard_starred_query_modal.tsx
new file mode 100644
index 0000000000000..5efa3a1469354
--- /dev/null
+++ b/packages/kbn-esql-editor/src/editor_footer/discard_starred_query/discard_starred_query_modal.tsx
@@ -0,0 +1,109 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import React, { useState, useCallback } from 'react';
+import { i18n } from '@kbn/i18n';
+import {
+ EuiModal,
+ EuiModalBody,
+ EuiModalFooter,
+ EuiModalHeader,
+ EuiModalHeaderTitle,
+ EuiButton,
+ EuiButtonEmpty,
+ EuiText,
+ EuiCheckbox,
+ EuiFlexItem,
+ EuiFlexGroup,
+ EuiHorizontalRule,
+} from '@elastic/eui';
+
+export interface DiscardStarredQueryModalProps {
+ onClose: (dismissFlag?: boolean, removeQuery?: boolean) => Promise;
+}
+// Needed for React.lazy
+// eslint-disable-next-line import/no-default-export
+export default function DiscardStarredQueryModal({ onClose }: DiscardStarredQueryModalProps) {
+ const [dismissModalChecked, setDismissModalChecked] = useState(false);
+ const onTransitionModalDismiss = useCallback((e: React.ChangeEvent) => {
+ setDismissModalChecked(e.target.checked);
+ }, []);
+
+ return (
+ onClose()}
+ style={{ width: 700 }}
+ data-test-subj="discard-starred-query-modal"
+ >
+
+
+ {i18n.translate('esqlEditor.discardStarredQueryModal.title', {
+ defaultMessage: 'Discard starred query',
+ })}
+
+
+
+
+
+ {i18n.translate('esqlEditor.discardStarredQueryModal.body', {
+ defaultMessage:
+ 'Removing a starred query will remove it from the list. This has no impact on the recent query history.',
+ })}
+
+
+
+
+
+
+
+
+
+
+
+ {
+ await onClose(dismissModalChecked, false);
+ }}
+ color="primary"
+ data-test-subj="esqlEditor-discard-starred-query-cancel-btn"
+ >
+ {i18n.translate('esqlEditor.discardStarredQueryModal.cancelLabel', {
+ defaultMessage: 'Cancel',
+ })}
+
+
+
+ {
+ await onClose(dismissModalChecked, true);
+ }}
+ color="danger"
+ iconType="trash"
+ data-test-subj="esqlEditor-discard-starred-query-discard-btn"
+ >
+ {i18n.translate('esqlEditor.discardStarredQueryModal.discardQueryLabel', {
+ defaultMessage: 'Discard query',
+ })}
+
+
+
+
+
+
+
+ );
+}
diff --git a/src/plugins/saved_objects/public/saved_object/helpers/field_mapping/types.ts b/packages/kbn-esql-editor/src/editor_footer/discard_starred_query/index.tsx
similarity index 51%
rename from src/plugins/saved_objects/public/saved_object/helpers/field_mapping/types.ts
rename to packages/kbn-esql-editor/src/editor_footer/discard_starred_query/index.tsx
index 4a1b3e0d3892d..544b251c76754 100644
--- a/src/plugins/saved_objects/public/saved_object/helpers/field_mapping/types.ts
+++ b/packages/kbn-esql-editor/src/editor_footer/discard_starred_query/index.tsx
@@ -7,14 +7,14 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-import { ES_FIELD_TYPES } from '@kbn/data-plugin/public';
+import React from 'react';
+import type { DiscardStarredQueryModalProps } from './discard_starred_query_modal';
-/** @public */
-export interface FieldMappingSpec {
- type: ES_FIELD_TYPES;
- _serialize?: (mapping: any) => string | undefined;
- _deserialize?: (mapping: string) => any | undefined;
-}
+const Fallback = () => ;
-/** @public */
-export type MappingObject = Record;
+const LazyDiscardStarredQueryModal = React.lazy(() => import('./discard_starred_query_modal'));
+export const DiscardStarredQueryModal = (props: DiscardStarredQueryModalProps) => (
+ }>
+
+
+);
diff --git a/packages/kbn-esql-editor/src/editor_footer/esql_starred_queries_service.test.tsx b/packages/kbn-esql-editor/src/editor_footer/esql_starred_queries_service.test.tsx
new file mode 100644
index 0000000000000..fca4d95c6f6cb
--- /dev/null
+++ b/packages/kbn-esql-editor/src/editor_footer/esql_starred_queries_service.test.tsx
@@ -0,0 +1,203 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { EsqlStarredQueriesService } from './esql_starred_queries_service';
+import { coreMock } from '@kbn/core/public/mocks';
+import type { Storage } from '@kbn/kibana-utils-plugin/public';
+
+class LocalStorageMock {
+ public store: Record;
+ constructor(defaultStore: Record) {
+ this.store = defaultStore;
+ }
+ clear() {
+ this.store = {};
+ }
+ get(key: string) {
+ return this.store[key] || null;
+ }
+ set(key: string, value: unknown) {
+ this.store[key] = String(value);
+ }
+ remove(key: string) {
+ delete this.store[key];
+ }
+}
+
+describe('EsqlStarredQueriesService', () => {
+ const core = coreMock.createStart();
+ const storage = new LocalStorageMock({}) as unknown as Storage;
+
+ it('should initialize', async () => {
+ const service = await EsqlStarredQueriesService.initialize({
+ http: core.http,
+ storage,
+ });
+ expect(service).toBeDefined();
+ expect(service.queries$.value).toEqual([]);
+ });
+
+ it('should add a new starred query', async () => {
+ const service = await EsqlStarredQueriesService.initialize({
+ http: core.http,
+ storage,
+ });
+ const query = {
+ queryString: 'SELECT * FROM test',
+ timeRan: '2021-09-01T00:00:00Z',
+ status: 'success' as const,
+ };
+
+ await service.addStarredQuery(query);
+ expect(service.queries$.value).toEqual([
+ {
+ id: expect.any(String),
+ ...query,
+ // stores now()
+ timeRan: expect.any(String),
+ },
+ ]);
+ });
+
+ it('should not add the same query twice', async () => {
+ const service = await EsqlStarredQueriesService.initialize({
+ http: core.http,
+ storage,
+ });
+ const query = {
+ queryString: 'SELECT * FROM test',
+ timeRan: '2021-09-01T00:00:00Z',
+ status: 'success' as const,
+ };
+
+ const expected = {
+ id: expect.any(String),
+ ...query,
+ // stores now()
+ timeRan: expect.any(String),
+ // trimmed query
+ queryString: 'SELECT * FROM test',
+ };
+
+ await service.addStarredQuery(query);
+ expect(service.queries$.value).toEqual([expected]);
+
+ // second time
+ await service.addStarredQuery(query);
+ expect(service.queries$.value).toEqual([expected]);
+ });
+
+ it('should add the query trimmed', async () => {
+ const service = await EsqlStarredQueriesService.initialize({
+ http: core.http,
+ storage,
+ });
+ const query = {
+ queryString: `SELECT * FROM test |
+ WHERE field != 'value'`,
+ timeRan: '2021-09-01T00:00:00Z',
+ status: 'error' as const,
+ };
+
+ await service.addStarredQuery(query);
+ expect(service.queries$.value).toEqual([
+ {
+ id: expect.any(String),
+ ...query,
+ timeRan: expect.any(String),
+ // trimmed query
+ queryString: `SELECT * FROM test | WHERE field != 'value'`,
+ },
+ ]);
+ });
+
+ it('should remove a query', async () => {
+ const service = await EsqlStarredQueriesService.initialize({
+ http: core.http,
+ storage,
+ });
+ const query = {
+ queryString: `SELECT * FROM test | WHERE field != 'value'`,
+ timeRan: '2021-09-01T00:00:00Z',
+ status: 'error' as const,
+ };
+
+ await service.addStarredQuery(query);
+ expect(service.queries$.value).toEqual([
+ {
+ id: expect.any(String),
+ ...query,
+ timeRan: expect.any(String),
+ // trimmed query
+ queryString: `SELECT * FROM test | WHERE field != 'value'`,
+ },
+ ]);
+
+ await service.removeStarredQuery(query.queryString);
+ expect(service.queries$.value).toEqual([]);
+ });
+
+ it('should return the button correctly', async () => {
+ const service = await EsqlStarredQueriesService.initialize({
+ http: core.http,
+ storage,
+ });
+ const query = {
+ queryString: 'SELECT * FROM test',
+ timeRan: '2021-09-01T00:00:00Z',
+ status: 'success' as const,
+ };
+
+ await service.addStarredQuery(query);
+ const buttonWithTooltip = service.renderStarredButton(query);
+ const button = buttonWithTooltip.props.children;
+ expect(button.props.title).toEqual('Remove ES|QL query from Starred');
+ expect(button.props.iconType).toEqual('starFilled');
+ });
+
+ it('should display the modal when the Remove button is clicked', async () => {
+ const service = await EsqlStarredQueriesService.initialize({
+ http: core.http,
+ storage,
+ });
+ const query = {
+ queryString: 'SELECT * FROM test',
+ timeRan: '2021-09-01T00:00:00Z',
+ status: 'success' as const,
+ };
+
+ await service.addStarredQuery(query);
+ const buttonWithTooltip = service.renderStarredButton(query);
+ const button = buttonWithTooltip.props.children;
+ expect(button.props.title).toEqual('Remove ES|QL query from Starred');
+ button.props.onClick();
+
+ expect(service.discardModalVisibility$.value).toEqual(true);
+ });
+
+ it('should NOT display the modal when Remove the button is clicked but the user has dismissed the modal permanently', async () => {
+ storage.set('esqlEditor.starredQueriesDiscard', true);
+ const service = await EsqlStarredQueriesService.initialize({
+ http: core.http,
+ storage,
+ });
+ const query = {
+ queryString: 'SELECT * FROM test',
+ timeRan: '2021-09-01T00:00:00Z',
+ status: 'success' as const,
+ };
+
+ await service.addStarredQuery(query);
+ const buttonWithTooltip = service.renderStarredButton(query);
+ const button = buttonWithTooltip.props.children;
+ button.props.onClick();
+
+ expect(service.discardModalVisibility$.value).toEqual(false);
+ });
+});
diff --git a/packages/kbn-esql-editor/src/editor_footer/esql_starred_queries_service.tsx b/packages/kbn-esql-editor/src/editor_footer/esql_starred_queries_service.tsx
new file mode 100644
index 0000000000000..80ef716cfd4b0
--- /dev/null
+++ b/packages/kbn-esql-editor/src/editor_footer/esql_starred_queries_service.tsx
@@ -0,0 +1,241 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+import React from 'react';
+import { BehaviorSubject } from 'rxjs';
+import { i18n } from '@kbn/i18n';
+import { v4 as uuidv4 } from 'uuid';
+import type { CoreStart } from '@kbn/core/public';
+import type { UsageCollectionStart } from '@kbn/usage-collection-plugin/public';
+import type { Storage } from '@kbn/kibana-utils-plugin/public';
+import { EuiButtonIcon } from '@elastic/eui';
+import { FavoritesClient } from '@kbn/content-management-favorites-public';
+import { FAVORITES_LIMIT as ESQL_STARRED_QUERIES_LIMIT } from '@kbn/content-management-favorites-common';
+import { type QueryHistoryItem, getTrimmedQuery } from '../history_local_storage';
+import { TooltipWrapper } from './tooltip_wrapper';
+
+const STARRED_QUERIES_DISCARD_KEY = 'esqlEditor.starredQueriesDiscard';
+
+/**
+ * EsqlStarredQueriesService is a service that manages the starred queries in the ES|QL editor.
+ * It provides methods to add and remove queries from the starred list.
+ * It also provides a method to render the starred button in the editor list table.
+ *
+ * @param client - The FavoritesClient instance.
+ * @param starredQueries - The list of starred queries.
+ * @param queries$ - The BehaviorSubject that emits the starred queries list.
+ * @method initialize - Initializes the service and retrieves the starred queries from the favoriteService.
+ * @method checkIfQueryIsStarred - Checks if a query is already starred.
+ * @method addStarredQuery - Adds a query to the starred list.
+ * @method removeStarredQuery - Removes a query from the starred list.
+ * @method renderStarredButton - Renders the starred button in the editor list table.
+ * @returns EsqlStarredQueriesService instance.
+ *
+ */
+export interface StarredQueryItem extends QueryHistoryItem {
+ id: string;
+}
+
+interface EsqlStarredQueriesServices {
+ http: CoreStart['http'];
+ storage: Storage;
+ usageCollection?: UsageCollectionStart;
+}
+
+interface EsqlStarredQueriesParams {
+ client: FavoritesClient;
+ starredQueries: StarredQueryItem[];
+ storage: Storage;
+}
+
+function generateId() {
+ return uuidv4();
+}
+
+interface StarredQueryMetadata {
+ queryString: string;
+ createdAt: string;
+ status: 'success' | 'warning' | 'error';
+}
+
+export class EsqlStarredQueriesService {
+ private client: FavoritesClient;
+ private starredQueries: StarredQueryItem[] = [];
+ private queryToEdit: string = '';
+ private storage: Storage;
+ queries$: BehaviorSubject;
+ discardModalVisibility$: BehaviorSubject = new BehaviorSubject(false);
+
+ constructor({ client, starredQueries, storage }: EsqlStarredQueriesParams) {
+ this.client = client;
+ this.starredQueries = starredQueries;
+ this.queries$ = new BehaviorSubject(starredQueries);
+ this.storage = storage;
+ }
+
+ static async initialize(services: EsqlStarredQueriesServices) {
+ const client = new FavoritesClient('esql_editor', 'esql_query', {
+ http: services.http,
+ usageCollection: services.usageCollection,
+ });
+
+ const { favoriteMetadata } = (await client?.getFavorites()) || {};
+ const retrievedQueries: StarredQueryItem[] = [];
+
+ if (!favoriteMetadata) {
+ return new EsqlStarredQueriesService({
+ client,
+ starredQueries: [],
+ storage: services.storage,
+ });
+ }
+ Object.keys(favoriteMetadata).forEach((id) => {
+ const item = favoriteMetadata[id];
+ const { queryString, createdAt, status } = item;
+ retrievedQueries.push({ id, queryString, timeRan: createdAt, status });
+ });
+
+ return new EsqlStarredQueriesService({
+ client,
+ starredQueries: retrievedQueries,
+ storage: services.storage,
+ });
+ }
+
+ private checkIfQueryIsStarred(queryString: string) {
+ return this.starredQueries.some((item) => item.queryString === queryString);
+ }
+
+ private checkIfStarredQueriesLimitReached() {
+ return this.starredQueries.length >= ESQL_STARRED_QUERIES_LIMIT;
+ }
+
+ async addStarredQuery(item: Pick) {
+ const favoriteItem: { id: string; metadata: StarredQueryMetadata } = {
+ id: generateId(),
+ metadata: {
+ queryString: getTrimmedQuery(item.queryString),
+ createdAt: new Date().toISOString(),
+ status: item.status ?? 'success',
+ },
+ };
+
+ // do not add the query if it's already starred or has reached the limit
+ if (
+ this.checkIfQueryIsStarred(favoriteItem.metadata.queryString) ||
+ this.checkIfStarredQueriesLimitReached()
+ ) {
+ return;
+ }
+
+ const starredQueries = [...this.starredQueries];
+
+ starredQueries.push({
+ queryString: favoriteItem.metadata.queryString,
+ timeRan: favoriteItem.metadata.createdAt,
+ status: favoriteItem.metadata.status,
+ id: favoriteItem.id,
+ });
+ this.queries$.next(starredQueries);
+ this.starredQueries = starredQueries;
+ await this.client.addFavorite(favoriteItem);
+
+ // telemetry, add favorite click event
+ this.client.reportAddFavoriteClick();
+ }
+
+ async removeStarredQuery(queryString: string) {
+ const trimmedQueryString = getTrimmedQuery(queryString);
+ const favoriteItem = this.starredQueries.find(
+ (item) => item.queryString === trimmedQueryString
+ );
+
+ if (!favoriteItem) {
+ return;
+ }
+
+ this.starredQueries = this.starredQueries.filter(
+ (item) => item.queryString !== trimmedQueryString
+ );
+ this.queries$.next(this.starredQueries);
+
+ await this.client.removeFavorite({ id: favoriteItem.id });
+
+ // telemetry, remove favorite click event
+ this.client.reportRemoveFavoriteClick();
+ }
+
+ async onDiscardModalClose(shouldDismissModal?: boolean, removeQuery?: boolean) {
+ if (shouldDismissModal) {
+ // set the local storage flag to not show the modal again
+ this.storage.set(STARRED_QUERIES_DISCARD_KEY, true);
+ }
+ this.discardModalVisibility$.next(false);
+
+ if (removeQuery) {
+ // remove the query
+ await this.removeStarredQuery(this.queryToEdit);
+ }
+ }
+
+ renderStarredButton(item: QueryHistoryItem) {
+ const trimmedQueryString = getTrimmedQuery(item.queryString);
+ const isStarred = this.checkIfQueryIsStarred(trimmedQueryString);
+ return (
+
+ {
+ this.queryToEdit = trimmedQueryString;
+ if (isStarred) {
+ // show the discard modal only if the user has not dismissed it
+ if (!this.storage.get(STARRED_QUERIES_DISCARD_KEY)) {
+ this.discardModalVisibility$.next(true);
+ } else {
+ await this.removeStarredQuery(item.queryString);
+ }
+ } else {
+ await this.addStarredQuery(item);
+ }
+ }}
+ data-test-subj="ESQLFavoriteButton"
+ />
+
+ );
+ }
+}
diff --git a/packages/kbn-esql-editor/src/editor_footer/query_history.test.tsx b/packages/kbn-esql-editor/src/editor_footer/history_starred_queries.test.tsx
similarity index 52%
rename from packages/kbn-esql-editor/src/editor_footer/query_history.test.tsx
rename to packages/kbn-esql-editor/src/editor_footer/history_starred_queries.test.tsx
index df41e2a2d3b91..9e0d586622c31 100644
--- a/packages/kbn-esql-editor/src/editor_footer/query_history.test.tsx
+++ b/packages/kbn-esql-editor/src/editor_footer/history_starred_queries.test.tsx
@@ -8,8 +8,15 @@
*/
import React from 'react';
-import { QueryHistoryAction, getTableColumns, QueryColumn } from './query_history';
+import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
+import { coreMock } from '@kbn/core/public/mocks';
import { render, screen } from '@testing-library/react';
+import {
+ QueryHistoryAction,
+ getTableColumns,
+ QueryColumn,
+ HistoryAndStarredQueriesTabs,
+} from './history_starred_queries';
jest.mock('../history_local_storage', () => {
const module = jest.requireActual('../history_local_storage');
@@ -18,7 +25,6 @@ jest.mock('../history_local_storage', () => {
getHistoryItems: () => [
{
queryString: 'from kibana_sample_data_flights | limit 10',
- timeZone: 'Browser',
timeRan: 'Mar. 25, 24 08:45:27',
queryRunning: false,
status: 'success',
@@ -27,7 +33,7 @@ jest.mock('../history_local_storage', () => {
};
});
-describe('QueryHistory', () => {
+describe('Starred and History queries components', () => {
describe('QueryHistoryAction', () => {
it('should render the history action component as a button if is spaceReduced is undefined', () => {
render();
@@ -47,9 +53,14 @@ describe('QueryHistory', () => {
});
describe('getTableColumns', () => {
- it('should get the history table columns correctly', async () => {
+ it('should get the table columns correctly', async () => {
const columns = getTableColumns(50, false, []);
expect(columns).toEqual([
+ {
+ 'data-test-subj': 'favoriteBtn',
+ render: expect.anything(),
+ width: '40px',
+ },
{
css: {
height: '100%',
@@ -64,7 +75,7 @@ describe('QueryHistory', () => {
{
'data-test-subj': 'queryString',
field: 'queryString',
- name: 'Recent queries',
+ name: 'Query',
render: expect.anything(),
},
{
@@ -83,11 +94,58 @@ describe('QueryHistory', () => {
},
]);
});
+
+ it('should get the table columns correctly for the starred list', async () => {
+ const columns = getTableColumns(50, false, [], true);
+ expect(columns).toEqual([
+ {
+ 'data-test-subj': 'favoriteBtn',
+ render: expect.anything(),
+ width: '40px',
+ },
+ {
+ css: {
+ height: '100%',
+ },
+ 'data-test-subj': 'status',
+ field: 'status',
+ name: '',
+ render: expect.anything(),
+ sortable: false,
+ width: '40px',
+ },
+ {
+ 'data-test-subj': 'queryString',
+ field: 'queryString',
+ name: 'Query',
+ render: expect.anything(),
+ },
+ {
+ 'data-test-subj': 'timeRan',
+ field: 'timeRan',
+ name: 'Date Added',
+ render: expect.anything(),
+ sortable: true,
+ width: '240px',
+ },
+ {
+ actions: [],
+ 'data-test-subj': 'actions',
+ name: '',
+ width: '60px',
+ },
+ ]);
+ });
});
it('should get the history table columns correctly for reduced space', async () => {
const columns = getTableColumns(50, true, []);
expect(columns).toEqual([
+ {
+ 'data-test-subj': 'favoriteBtn',
+ render: expect.anything(),
+ width: 'auto',
+ },
{
css: {
height: '100%',
@@ -110,7 +168,7 @@ describe('QueryHistory', () => {
{
'data-test-subj': 'queryString',
field: 'queryString',
- name: 'Recent queries',
+ name: 'Query',
render: expect.anything(),
},
{
@@ -132,7 +190,7 @@ describe('QueryHistory', () => {
/>
);
expect(
- screen.queryByTestId('ESQLEditor-queryHistory-queryString-expanded')
+ screen.queryByTestId('ESQLEditor-queryList-queryString-expanded')
).not.toBeInTheDocument();
});
@@ -152,9 +210,66 @@ describe('QueryHistory', () => {
isOnReducedSpaceLayout={true}
/>
);
- expect(
- screen.getByTestId('ESQLEditor-queryHistory-queryString-expanded')
- ).toBeInTheDocument();
+ expect(screen.getByTestId('ESQLEditor-queryList-queryString-expanded')).toBeInTheDocument();
+ });
+ });
+
+ describe('HistoryAndStarredQueriesTabs', () => {
+ const services = {
+ core: coreMock.createStart(),
+ };
+ it('should render two tabs', () => {
+ render(
+
+
+
+ );
+ expect(screen.getByTestId('history-queries-tab')).toBeInTheDocument();
+ expect(screen.getByTestId('history-queries-tab')).toHaveTextContent('Recent');
+ expect(screen.getByTestId('starred-queries-tab')).toBeInTheDocument();
+ expect(screen.getByTestId('starred-queries-tab')).toHaveTextContent('Starred');
+ });
+
+ it('should render the history queries tab by default', () => {
+ render(
+
+
+
+ );
+ expect(screen.getByTestId('ESQLEditor-queryHistory')).toBeInTheDocument();
+ expect(screen.getByTestId('ESQLEditor-history-starred-queries-helpText')).toHaveTextContent(
+ 'Showing last 20 queries'
+ );
+ });
+
+ it('should render the starred queries if the corresponding btn is clicked', () => {
+ render(
+
+
+
+ );
+ // click the starred queries tab
+ screen.getByTestId('starred-queries-tab').click();
+
+ expect(screen.getByTestId('ESQLEditor-starredQueries')).toBeInTheDocument();
+ expect(screen.getByTestId('ESQLEditor-history-starred-queries-helpText')).toHaveTextContent(
+ 'Showing 0 queries (max 100)'
+ );
});
});
});
diff --git a/packages/kbn-esql-editor/src/editor_footer/query_history.tsx b/packages/kbn-esql-editor/src/editor_footer/history_starred_queries.tsx
similarity index 53%
rename from packages/kbn-esql-editor/src/editor_footer/query_history.tsx
rename to packages/kbn-esql-editor/src/editor_footer/history_starred_queries.tsx
index 864306737e9ca..c24d0a0b1817b 100644
--- a/packages/kbn-esql-editor/src/editor_footer/query_history.tsx
+++ b/packages/kbn-esql-editor/src/editor_footer/history_starred_queries.tsx
@@ -6,8 +6,8 @@
* your election, the "Elastic License 2.0", the "GNU Affero General Public
* License v3.0 only", or the "Server Side Public License, v 1".
*/
-
-import React, { useState, useRef, useEffect, useMemo } from 'react';
+import React, { useState, useRef, useEffect, useMemo, useCallback } from 'react';
+import moment from 'moment';
import { i18n } from '@kbn/i18n';
import {
EuiFlexGroup,
@@ -17,16 +17,31 @@ import {
EuiInMemoryTable,
EuiBasicTableColumn,
EuiButtonEmpty,
- Criteria,
EuiButtonIcon,
CustomItemAction,
EuiCopy,
EuiToolTip,
euiScrollBarStyles,
+ EuiTab,
+ EuiTabs,
+ EuiNotificationBadge,
+ EuiText,
} from '@elastic/eui';
+import { useKibana } from '@kbn/kibana-react-plugin/public';
+import { cssFavoriteHoverWithinEuiTableRow } from '@kbn/content-management-favorites-public';
+import { FAVORITES_LIMIT as ESQL_STARRED_QUERIES_LIMIT } from '@kbn/content-management-favorites-common';
import { css, Interpolation, Theme } from '@emotion/react';
-import { type QueryHistoryItem, getHistoryItems } from '../history_local_storage';
-import { getReducedSpaceStyling, swapArrayElements } from './query_history_helpers';
+import { useEuiTablePersist } from '@kbn/shared-ux-table-persist';
+import {
+ type QueryHistoryItem,
+ getHistoryItems,
+ MAX_HISTORY_QUERIES_NUMBER,
+ dateFormat,
+} from '../history_local_storage';
+import type { ESQLEditorDeps } from '../types';
+import { getReducedSpaceStyling, swapArrayElements } from './history_starred_queries_helpers';
+import { EsqlStarredQueriesService, StarredQueryItem } from './esql_starred_queries_service';
+import { DiscardStarredQueryModal } from './discard_starred_query';
export function QueryHistoryAction({
toggleHistory,
@@ -99,9 +114,22 @@ export function QueryHistoryAction({
export const getTableColumns = (
width: number,
isOnReducedSpaceLayout: boolean,
- actions: Array>
+ actions: Array>,
+ isStarredTab = false,
+ starredQueriesService?: EsqlStarredQueriesService
): Array> => {
const columnsArray = [
+ {
+ 'data-test-subj': 'favoriteBtn',
+ render: (item: QueryHistoryItem) => {
+ const StarredQueryButton = starredQueriesService?.renderStarredButton(item);
+ if (!StarredQueryButton) {
+ return null;
+ }
+ return StarredQueryButton;
+ },
+ width: isOnReducedSpaceLayout ? 'auto' : '40px',
+ },
{
field: 'status',
name: '',
@@ -167,7 +195,7 @@ export const getTableColumns = (
field: 'queryString',
'data-test-subj': 'queryString',
name: i18n.translate('esqlEditor.query.recentQueriesColumnLabel', {
- defaultMessage: 'Recent queries',
+ defaultMessage: 'Query',
}),
render: (queryString: QueryHistoryItem['queryString']) => (
timeRan,
+ render: (timeRan: QueryHistoryItem['timeRan']) => moment(timeRan).format(dateFormat),
width: isOnReducedSpaceLayout ? 'auto' : '240px',
},
{
@@ -196,24 +228,41 @@ export const getTableColumns = (
];
// I need to swap the elements here to get the desired design
- return isOnReducedSpaceLayout ? swapArrayElements(columnsArray, 1, 2) : columnsArray;
+ return isOnReducedSpaceLayout ? swapArrayElements(columnsArray, 2, 3) : columnsArray;
};
-export function QueryHistory({
+export function QueryList({
containerCSS,
containerWidth,
onUpdateAndSubmit,
height,
+ listItems,
+ starredQueriesService,
+ tableCaption,
+ dataTestSubj,
+ isStarredTab = false,
}: {
+ listItems: QueryHistoryItem[];
containerCSS: Interpolation;
containerWidth: number;
onUpdateAndSubmit: (qs: string) => void;
height: number;
+ starredQueriesService?: EsqlStarredQueriesService;
+ tableCaption?: string;
+ dataTestSubj?: string;
+ isStarredTab?: boolean;
}) {
const theme = useEuiTheme();
const scrollBarStyles = euiScrollBarStyles(theme);
- const [sortDirection, setSortDirection] = useState<'asc' | 'desc'>('desc');
- const historyItems: QueryHistoryItem[] = getHistoryItems(sortDirection);
+ const [isDiscardQueryModalVisible, setIsDiscardQueryModalVisible] = useState(false);
+
+ const { sorting, onTableChange } = useEuiTablePersist({
+ tableId: 'esqlQueryHistory',
+ initialSort: {
+ field: 'timeRan',
+ direction: 'desc',
+ },
+ });
const actions: Array