@elastic/schemas 0.4.5 → 0.5.1

package/lib/cjs/kibana/json/fleet-package-policies.post-fleet-package-policies-bulk-get.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-package-policies-bulk-get", "x-api": { "id": "fleet-package-policies.post-fleet-package-policies-bulk-get", "name": "post-fleet-package-policies-bulk-get", "namespace": "fleet-package-policies" }, "x-method": "POST", "x-path": "/api/fleet/package_policies/_bulk_get", "x-destructive": true, "type": "object", "properties": { "format": { "enum": ["simplified", "legacy"], "description": "Format for the response: simplified or legacy", "x-found-in": "query" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "list of package policy ids", "x-found-in": "body" }, "ignoreMissing": { "type": "boolean", "x-found-in": "body" } }, "required": ["ids"] }

package/lib/cjs/kibana/json/fleet-package-policies.post-fleet-package-policies-delete.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-package-policies-delete", "x-api": { "id": "fleet-package-policies.post-fleet-package-policies-delete", "name": "post-fleet-package-policies-delete", "namespace": "fleet-package-policies" }, "x-method": "POST", "x-path": "/api/fleet/package_policies/delete", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_delete_package_policies_request", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/fleet-package-policies.post-fleet-package-policies-upgrade-dryrun.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-package-policies-upgrade-dryrun", "x-api": { "id": "fleet-package-policies.post-fleet-package-policies-upgrade-dryrun", "name": "post-fleet-package-policies-upgrade-dryrun", "namespace": "fleet-package-policies" }, "x-method": "POST", "x-path": "/api/fleet/package_policies/upgrade/dryrun", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_dry_run_package_policies_request", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/fleet-package-policies.post-fleet-package-policies-upgrade.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-package-policies-upgrade", "x-api": { "id": "fleet-package-policies.post-fleet-package-policies-upgrade", "name": "post-fleet-package-policies-upgrade", "namespace": "fleet-package-policies" }, "x-method": "POST", "x-path": "/api/fleet/package_policies/upgrade", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_upgrade_package_policies_request", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/fleet-package-policies.post-fleet-package-policies.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-package-policies", "x-api": { "id": "fleet-package-policies.post-fleet-package-policies", "name": "post-fleet-package-policies", "namespace": "fleet-package-policies" }, "x-method": "POST", "x-path": "/api/fleet/package_policies", "x-destructive": false, "type": "object", "properties": { "format": { "enum": ["simplified", "legacy"], "description": "Format for the response: simplified or legacy", "x-found-in": "query" }, "additional_datastreams_permissions": { "oneOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Additional data stream permissions that will be added to the agent policy.", "x-found-in": "body" }, "cloud_connector_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "ID of the cloud connector associated with this package policy.", "x-found-in": "body" }, "cloud_connector_name": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Transient field for cloud connector name during creation.", "x-found-in": "body" }, "condition": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Agent condition expression to evaluate whether to apply this integration to its inputs.", "x-found-in": "body" }, "create_dataset_templates": { "type": "boolean", "description": "When true, install dedicated index templates for streams with a custom data_stream.dataset. Defaults to true for input packages, false for integration packages.", "x-found-in": "body" }, "description": { "type": "string", "description": "Policy description.", "x-found-in": "body" }, "enabled": { "type": "boolean", "x-found-in": "body" }, "force": { "type": "boolean", "description": "Force package policy creation even if the package is not verified, or if the agent policy is managed.", "x-found-in": "body" }, "global_data_tags": { "oneOf": [{ "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom field. Cannot contain spaces." }, "value": { "oneOf": [{ "type": "string" }, { "type": "number" }], "description": "The value of the custom field." } }, "required": ["name", "value"] } }, { "type": "null" }], "x-found-in": "body" }, "id": { "type": "string", "description": "Policy unique identifier.", "x-found-in": "body" }, "inputs": { "type": "object", "additionalProperties": { "type": "object", "properties": { "condition": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Agent condition expression to evaluate whether to apply this input." }, "deprecated": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_deprecation_info" }, "enabled": { "type": "boolean", "description": "Enable or disable that input. Defaults to `true` (enabled)." }, "streams": { "type": "object", "additionalProperties": { "type": "object", "properties": { "condition": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Agent condition expression to evaluate whether to apply this stream." }, "deprecated": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_deprecation_info" }, "enabled": { "type": "boolean", "description": "Enable or disable that stream. Defaults to `true` (enabled)." }, "var_group_selections": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Variable group selections. Maps var_group name to the selected option name within that group." }, "vars": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } }, { "type": "object", "properties": { "id": { "type": "string" }, "isSecretRef": { "type": "boolean" } }, "required": ["id", "isSecretRef"] }, { "type": "null" }] }, "description": "Input/stream level variable. Refer to the integration documentation for more information." } } }, "description": "Input streams. Refer to the integration documentation to know which streams are available." }, "vars": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } }, { "type": "object", "properties": { "id": { "type": "string" }, "isSecretRef": { "type": "boolean" } }, "required": ["id", "isSecretRef"] }, { "type": "null" }] }, "description": "Input/stream level variable. Refer to the integration documentation for more information." } } }, "description": "Package policy inputs. Refer to the integration documentation to know which inputs are available.", "x-found-in": "body" }, "is_managed": { "type": "boolean", "x-found-in": "body" }, "name": { "type": "string", "description": "Unique name for the policy.", "x-found-in": "body" }, "namespace": { "type": "string", "description": "Policy namespace. When not specified, it inherits the agent policy namespace.", "x-found-in": "body" }, "output_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "overrides": { "oneOf": [{ "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": {} } } }, { "type": "null" }], "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.", "x-found-in": "body" }, "package": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_package_policy_package", "x-found-in": "body" }, "package_agent_version_condition": { "type": "string", "x-found-in": "body" }, "policy_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Deprecated. Use policy_ids instead.", "x-found-in": "body" }, "policy_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the agent policies that the package policy will be added to.", "x-found-in": "body" }, "spaceIds": { "type": "array", "items": { "type": "string" }, "x-found-in": "body" }, "supports_agentless": { "oneOf": [{ "type": "boolean" }, { "type": "null" }], "description": "Indicates whether the package policy belongs to an agentless agent policy. Deprecated in favor of the Fleet agentless policies API.", "x-found-in": "body" }, "supports_cloud_connector": { "oneOf": [{ "type": "boolean" }, { "type": "null" }], "description": "Indicates whether the package policy supports cloud connectors.", "x-found-in": "body" }, "var_group_selections": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Variable group selections. Maps var_group name to the selected option name within that group.", "x-found-in": "body" }, "vars": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } }, { "type": "object", "properties": { "id": { "type": "string" }, "isSecretRef": { "type": "boolean" } }, "required": ["id", "isSecretRef"] }, { "type": "null" }] }, "description": "Input/stream level variable. Refer to the integration documentation for more information.", "x-found-in": "body" } }, "required": ["name"] }

package/lib/cjs/kibana/json/fleet-package-policies.put-fleet-package-policies-packagepolicyid.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "put-fleet-package-policies-packagepolicyid", "x-api": { "id": "fleet-package-policies.put-fleet-package-policies-packagepolicyid", "name": "put-fleet-package-policies-packagepolicyid", "namespace": "fleet-package-policies" }, "x-method": "PUT", "x-path": "/api/fleet/package_policies/{packagePolicyId}", "x-destructive": true, "type": "object", "properties": { "packagePolicyId": { "type": "string", "description": "The ID of the package policy", "x-found-in": "path" }, "format": { "enum": ["simplified", "legacy"], "description": "Format for the response: simplified or legacy", "x-found-in": "query" }, "additional_datastreams_permissions": { "oneOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "description": "Additional data stream permissions that will be added to the agent policy.", "x-found-in": "body" }, "cloud_connector_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "ID of the cloud connector associated with this package policy.", "x-found-in": "body" }, "cloud_connector_name": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Transient field for cloud connector name during creation.", "x-found-in": "body" }, "condition": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Agent condition expression to evaluate whether to apply this integration to its inputs.", "x-found-in": "body" }, "description": { "type": "string", "description": "Policy description.", "x-found-in": "body" }, "enabled": { "type": "boolean", "x-found-in": "body" }, "force": { "type": "boolean", "description": "Force package policy creation even if the package is not verified, or if the agent policy is managed.", "x-found-in": "body" }, "global_data_tags": { "oneOf": [{ "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom field. Cannot contain spaces." }, "value": { "oneOf": [{ "type": "string" }, { "type": "number" }], "description": "The value of the custom field." } }, "required": ["name", "value"] } }, { "type": "null" }], "x-found-in": "body" }, "inputs": { "type": "object", "additionalProperties": { "type": "object", "properties": { "condition": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Agent condition expression to evaluate whether to apply this input." }, "deprecated": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_deprecation_info" }, "enabled": { "type": "boolean", "description": "Enable or disable that input. Defaults to `true` (enabled)." }, "streams": { "type": "object", "additionalProperties": { "type": "object", "properties": { "condition": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Agent condition expression to evaluate whether to apply this stream." }, "deprecated": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_deprecation_info" }, "enabled": { "type": "boolean", "description": "Enable or disable that stream. Defaults to `true` (enabled)." }, "var_group_selections": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Variable group selections. Maps var_group name to the selected option name within that group." }, "vars": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } }, { "type": "object", "properties": { "id": { "type": "string" }, "isSecretRef": { "type": "boolean" } }, "required": ["id", "isSecretRef"] }, { "type": "null" }] }, "description": "Input/stream level variable. Refer to the integration documentation for more information." } } }, "description": "Input streams. Refer to the integration documentation to know which streams are available." }, "vars": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } }, { "type": "object", "properties": { "id": { "type": "string" }, "isSecretRef": { "type": "boolean" } }, "required": ["id", "isSecretRef"] }, { "type": "null" }] }, "description": "Input/stream level variable. Refer to the integration documentation for more information." } } }, "description": "Package policy inputs. Refer to the integration documentation to know which inputs are available.", "x-found-in": "body" }, "is_managed": { "type": "boolean", "x-found-in": "body" }, "name": { "type": "string", "description": "Unique name for the policy.", "x-found-in": "body" }, "namespace": { "type": "string", "description": "Policy namespace. When not specified, it inherits the agent policy namespace.", "x-found-in": "body" }, "output_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "overrides": { "oneOf": [{ "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": {} } } }, { "type": "null" }], "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.", "x-found-in": "body" }, "package": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_package_policy_package", "x-found-in": "body" }, "package_agent_version_condition": { "type": "string", "x-found-in": "body" }, "policy_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Deprecated. Use policy_ids instead.", "x-found-in": "body" }, "policy_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the agent policies that the package policy will be added to.", "x-found-in": "body" }, "spaceIds": { "type": "array", "items": { "type": "string" }, "x-found-in": "body" }, "supports_agentless": { "oneOf": [{ "type": "boolean" }, { "type": "null" }], "description": "Indicates whether the package policy belongs to an agentless agent policy. Deprecated in favor of the Fleet agentless policies API.", "x-found-in": "body" }, "supports_cloud_connector": { "oneOf": [{ "type": "boolean" }, { "type": "null" }], "description": "Indicates whether the package policy supports cloud connectors.", "x-found-in": "body" }, "var_group_selections": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Variable group selections. Maps var_group name to the selected option name within that group.", "x-found-in": "body" }, "vars": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } }, { "type": "object", "properties": { "id": { "type": "string" }, "isSecretRef": { "type": "boolean" } }, "required": ["id", "isSecretRef"] }, { "type": "null" }] }, "description": "Input/stream level variable. Refer to the integration documentation for more information.", "x-found-in": "body" }, "version": { "type": "string", "x-found-in": "body" }, "create_dataset_templates": { "type": "boolean", "description": "When true, install dedicated index templates for streams with a custom data_stream.dataset. Defaults to true for input packages, false for integration packages.", "x-found-in": "body" }, "id": { "type": "string", "description": "Policy unique identifier.", "x-found-in": "body" } }, "required": ["packagePolicyId"] }

package/lib/cjs/kibana/json/fleet-proxies.delete-fleet-proxies-itemid.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete-fleet-proxies-itemid", "x-api": { "id": "fleet-proxies.delete-fleet-proxies-itemid", "name": "delete-fleet-proxies-itemid", "namespace": "fleet-proxies" }, "x-method": "DELETE", "x-path": "/api/fleet/proxies/{itemId}", "x-destructive": true, "type": "object", "properties": { "itemId": { "type": "string", "description": "The ID of the proxy", "x-found-in": "path" } }, "required": ["itemId"] }

package/lib/cjs/kibana/json/fleet-proxies.get-fleet-proxies-itemid.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-proxies-itemid", "x-api": { "id": "fleet-proxies.get-fleet-proxies-itemid", "name": "get-fleet-proxies-itemid", "namespace": "fleet-proxies" }, "x-method": "GET", "x-path": "/api/fleet/proxies/{itemId}", "x-destructive": false, "type": "object", "properties": { "itemId": { "type": "string", "description": "The ID of the proxy", "x-found-in": "path" } }, "required": ["itemId"] }

package/lib/cjs/kibana/json/fleet-proxies.post-fleet-proxies.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-proxies", "x-api": { "id": "fleet-proxies.post-fleet-proxies", "name": "post-fleet-proxies", "namespace": "fleet-proxies" }, "x-method": "POST", "x-path": "/api/fleet/proxies", "x-destructive": false, "type": "object", "properties": { "certificate": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "certificate_authorities": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "certificate_key": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "id": { "type": "string", "x-found-in": "body" }, "is_preconfigured": { "type": "boolean", "x-found-in": "body" }, "name": { "type": "string", "x-found-in": "body" }, "proxy_headers": { "oneOf": [{ "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "boolean" }, { "type": "number" }] } }, { "type": "null" }], "x-found-in": "body" }, "url": { "type": "string", "x-found-in": "body" } }, "required": ["url", "name"] }

package/lib/cjs/kibana/json/fleet-proxies.put-fleet-proxies-itemid.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "put-fleet-proxies-itemid", "x-api": { "id": "fleet-proxies.put-fleet-proxies-itemid", "name": "put-fleet-proxies-itemid", "namespace": "fleet-proxies" }, "x-method": "PUT", "x-path": "/api/fleet/proxies/{itemId}", "x-destructive": true, "type": "object", "properties": { "itemId": { "type": "string", "description": "The ID of the proxy", "x-found-in": "path" }, "certificate": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "certificate_authorities": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "certificate_key": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "name": { "type": "string", "x-found-in": "body" }, "proxy_headers": { "oneOf": [{ "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "boolean" }, { "type": "number" }] } }, { "type": "null" }], "x-found-in": "body" }, "url": { "type": "string", "x-found-in": "body" } }, "required": ["itemId"] }

package/lib/cjs/kibana/json/fleet-server-hosts.delete-fleet-fleet-server-hosts-itemid.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete-fleet-fleet-server-hosts-itemid", "x-api": { "id": "fleet-server-hosts.delete-fleet-fleet-server-hosts-itemid", "name": "delete-fleet-fleet-server-hosts-itemid", "namespace": "fleet-server-hosts" }, "x-method": "DELETE", "x-path": "/api/fleet/fleet_server_hosts/{itemId}", "x-destructive": true, "type": "object", "properties": { "itemId": { "type": "string", "description": "The ID of the Fleet Server host", "x-found-in": "path" } }, "required": ["itemId"] }

package/lib/cjs/kibana/json/fleet-server-hosts.get-fleet-fleet-server-hosts-itemid.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-fleet-server-hosts-itemid", "x-api": { "id": "fleet-server-hosts.get-fleet-fleet-server-hosts-itemid", "name": "get-fleet-fleet-server-hosts-itemid", "namespace": "fleet-server-hosts" }, "x-method": "GET", "x-path": "/api/fleet/fleet_server_hosts/{itemId}", "x-destructive": false, "type": "object", "properties": { "itemId": { "type": "string", "description": "The ID of the Fleet Server host", "x-found-in": "path" } }, "required": ["itemId"] }

package/lib/cjs/kibana/json/fleet-server-hosts.post-fleet-fleet-server-hosts.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-fleet-server-hosts", "x-api": { "id": "fleet-server-hosts.post-fleet-fleet-server-hosts", "name": "post-fleet-fleet-server-hosts", "namespace": "fleet-server-hosts" }, "x-method": "POST", "x-path": "/api/fleet/fleet_server_hosts", "x-destructive": false, "type": "object", "properties": { "host_urls": { "type": "array", "items": { "type": "string" }, "x-found-in": "body" }, "id": { "type": "string", "x-found-in": "body" }, "is_default": { "type": "boolean", "x-found-in": "body" }, "is_internal": { "type": "boolean", "x-found-in": "body" }, "is_preconfigured": { "type": "boolean", "x-found-in": "body" }, "name": { "type": "string", "x-found-in": "body" }, "proxy_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "secrets": { "type": "object", "properties": { "ssl": { "type": "object", "properties": { "agent_key": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, { "type": "string" }] }, "es_key": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, { "type": "string" }] }, "key": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, { "type": "string" }] } } } }, "x-found-in": "body" }, "ssl": { "oneOf": [{ "type": "object", "properties": { "agent_certificate": { "type": "string" }, "agent_certificate_authorities": { "type": "array", "items": { "type": "string" } }, "agent_key": { "type": "string" }, "certificate": { "type": "string" }, "certificate_authorities": { "type": "array", "items": { "type": "string" } }, "client_auth": { "enum": ["optional", "required", "none"] }, "es_certificate": { "type": "string" }, "es_certificate_authorities": { "type": "array", "items": { "type": "string" } }, "es_key": { "type": "string" }, "key": { "type": "string" } } }, { "type": "null" }], "x-found-in": "body" } }, "required": ["name", "host_urls"] }

package/lib/cjs/kibana/json/fleet-server-hosts.put-fleet-fleet-server-hosts-itemid.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "put-fleet-fleet-server-hosts-itemid", "x-api": { "id": "fleet-server-hosts.put-fleet-fleet-server-hosts-itemid", "name": "put-fleet-fleet-server-hosts-itemid", "namespace": "fleet-server-hosts" }, "x-method": "PUT", "x-path": "/api/fleet/fleet_server_hosts/{itemId}", "x-destructive": true, "type": "object", "properties": { "itemId": { "type": "string", "description": "The ID of the Fleet Server host", "x-found-in": "path" }, "host_urls": { "type": "array", "items": { "type": "string" }, "x-found-in": "body" }, "is_default": { "type": "boolean", "x-found-in": "body" }, "is_internal": { "type": "boolean", "x-found-in": "body" }, "name": { "type": "string", "x-found-in": "body" }, "proxy_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "x-found-in": "body" }, "secrets": { "type": "object", "properties": { "ssl": { "type": "object", "properties": { "agent_key": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, { "type": "string" }] }, "es_key": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, { "type": "string" }] }, "key": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, { "type": "string" }] } } } }, "x-found-in": "body" }, "ssl": { "oneOf": [{ "type": "object", "properties": { "agent_certificate": { "type": "string" }, "agent_certificate_authorities": { "type": "array", "items": { "type": "string" } }, "agent_key": { "type": "string" }, "certificate": { "type": "string" }, "certificate_authorities": { "type": "array", "items": { "type": "string" } }, "client_auth": { "enum": ["optional", "required", "none"] }, "es_certificate": { "type": "string" }, "es_certificate_authorities": { "type": "array", "items": { "type": "string" } }, "es_key": { "type": "string" }, "key": { "type": "string" } } }, { "type": "null" }], "x-found-in": "body" } }, "required": ["itemId"] }

package/lib/cjs/kibana/json/fleet-service-tokens.post-fleet-service-tokens.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-service-tokens", "x-api": { "id": "fleet-service-tokens.post-fleet-service-tokens", "name": "post-fleet-service-tokens", "namespace": "fleet-service-tokens" }, "x-method": "POST", "x-path": "/api/fleet/service_tokens", "x-destructive": false, "type": "object", "properties": { "body": { "oneOf": [{ "type": "object", "properties": { "remote": { "type": "boolean" } } }, { "type": "null" }], "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/fleet-uninstall-tokens.get-fleet-uninstall-tokens-uninstalltokenid.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-uninstall-tokens-uninstalltokenid", "x-api": { "id": "fleet-uninstall-tokens.get-fleet-uninstall-tokens-uninstalltokenid", "name": "get-fleet-uninstall-tokens-uninstalltokenid", "namespace": "fleet-uninstall-tokens" }, "x-method": "GET", "x-path": "/api/fleet/uninstall_tokens/{uninstallTokenId}", "x-destructive": false, "type": "object", "properties": { "uninstallTokenId": { "type": "string", "description": "The ID of the uninstall token", "x-found-in": "path" } }, "required": ["uninstallTokenId"] }

package/lib/cjs/kibana/json/fleet-uninstall-tokens.get-fleet-uninstall-tokens.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-uninstall-tokens", "x-api": { "id": "fleet-uninstall-tokens.get-fleet-uninstall-tokens", "name": "get-fleet-uninstall-tokens", "namespace": "fleet-uninstall-tokens" }, "x-method": "GET", "x-path": "/api/fleet/uninstall_tokens", "x-destructive": false, "type": "object", "properties": { "policyId": { "type": "string", "description": "Partial match filtering for policy IDs", "x-found-in": "query" }, "search": { "type": "string", "description": "Partial match filtering for uninstall token values", "x-found-in": "query" }, "perPage": { "type": "number", "description": "The number of items to return", "x-found-in": "query" }, "page": { "type": "number", "description": "Page number", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/maintenance-window.delete-maintenance-window-id.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete-maintenance-window-id", "x-api": { "id": "maintenance-window.delete-maintenance-window-id", "name": "delete-maintenance-window-id", "namespace": "maintenance-window" }, "x-method": "DELETE", "x-path": "/api/maintenance_window/{id}", "x-destructive": true, "x-availability": { "serverless": { "stability": "stable" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the maintenance window to be deleted.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/maintenance-window.get-maintenance-window-find.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-maintenance-window-find", "x-api": { "id": "maintenance-window.get-maintenance-window-find", "name": "get-maintenance-window-find", "namespace": "maintenance-window" }, "x-method": "GET", "x-path": "/api/maintenance_window/_find", "x-destructive": false, "x-availability": { "serverless": { "stability": "stable" } }, "type": "object", "properties": { "title": { "type": "string", "description": "The title of the maintenance window.", "x-found-in": "query" }, "created_by": { "type": "string", "description": "The user who created the maintenance window.", "x-found-in": "query" }, "status": { "type": "array", "items": { "enum": ["running", "finished", "upcoming", "archived", "disabled"] }, "description": "The status of the maintenance window. It can be \"running\", \"upcoming\", \"finished\", \"archived\", or \"disabled\".", "x-found-in": "query" }, "page": { "type": "number", "description": "The page number to return.", "x-found-in": "query" }, "per_page": { "type": "number", "description": "The number of maintenance windows to return per page.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/maintenance-window.get-maintenance-window-id.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-maintenance-window-id", "x-api": { "id": "maintenance-window.get-maintenance-window-id", "name": "get-maintenance-window-id", "namespace": "maintenance-window" }, "x-method": "GET", "x-path": "/api/maintenance_window/{id}", "x-destructive": false, "x-availability": { "serverless": { "stability": "stable" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the maintenance window.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/maintenance-window.patch-maintenance-window-id.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "patch-maintenance-window-id", "x-api": { "id": "maintenance-window.patch-maintenance-window-id", "name": "patch-maintenance-window-id", "namespace": "maintenance-window" }, "x-method": "PATCH", "x-path": "/api/maintenance_window/{id}", "x-destructive": true, "x-availability": { "serverless": { "stability": "stable" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the maintenance window.", "x-found-in": "path" }, "body": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_update_maintenance_window", "x-found-in": "body", "x-body-root": true } }, "required": ["id"] }

package/lib/cjs/kibana/json/maintenance-window.post-maintenance-window-id-archive.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-maintenance-window-id-archive", "x-api": { "id": "maintenance-window.post-maintenance-window-id-archive", "name": "post-maintenance-window-id-archive", "namespace": "maintenance-window" }, "x-method": "POST", "x-path": "/api/maintenance_window/{id}/_archive", "x-destructive": true, "x-availability": { "serverless": { "stability": "stable" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the maintenance window to be archived.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/maintenance-window.post-maintenance-window-id-unarchive.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-maintenance-window-id-unarchive", "x-api": { "id": "maintenance-window.post-maintenance-window-id-unarchive", "name": "post-maintenance-window-id-unarchive", "namespace": "maintenance-window" }, "x-method": "POST", "x-path": "/api/maintenance_window/{id}/_unarchive", "x-destructive": true, "x-availability": { "serverless": { "stability": "stable" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the maintenance window to be unarchived.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/maintenance-window.post-maintenance-window.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-maintenance-window", "x-api": { "id": "maintenance-window.post-maintenance-window", "name": "post-maintenance-window", "namespace": "maintenance-window" }, "x-method": "POST", "x-path": "/api/maintenance_window", "x-destructive": false, "x-availability": { "serverless": { "stability": "stable" } }, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_new_maintenance_window", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/message-signing-service.post-fleet-message-signing-service-rotate-key-pair.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-message-signing-service-rotate-key-pair", "x-api": { "id": "message-signing-service.post-fleet-message-signing-service-rotate-key-pair", "name": "post-fleet-message-signing-service-rotate-key-pair", "namespace": "message-signing-service" }, "x-method": "POST", "x-path": "/api/fleet/message_signing_service/rotate_key_pair", "x-destructive": true, "type": "object", "properties": { "acknowledge": { "type": "boolean", "description": "Set to true to confirm you understand the risks of rotating the key pair", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/misc.post-security-role-query.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-security-role-query", "x-api": { "id": "misc.post-security-role-query", "name": "post-security-role-query", "namespace": "misc" }, "x-method": "POST", "x-path": "/api/security/role/_query", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_security_query_roles_body", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/misc.put-fleet-space-settings.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "put-fleet-space-settings", "x-api": { "id": "misc.put-fleet-space-settings", "name": "put-fleet-space-settings", "namespace": "misc" }, "x-method": "PUT", "x-path": "/api/fleet/space_settings", "x-destructive": false, "x-availability": { "serverless": { "stability": "stable" } }, "type": "object", "properties": { "allowed_namespace_prefixes": { "type": "array", "items": { "type": "string" }, "x-found-in": "body" } } }

package/lib/cjs/kibana/json/observabilityaiassistant.observability-ai-assistant-chat-complete.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "observability-ai-assistant-chat-complete", "x-api": { "id": "observabilityaiassistant.observability-ai-assistant-chat-complete", "name": "observability-ai-assistant-chat-complete", "namespace": "observabilityaiassistant" }, "x-method": "POST", "x-path": "/api/observability_ai_assistant/chat/complete", "x-destructive": true, "x-availability": { "serverless": { "stability": "tech_preview" } }, "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Observability_AI_Assistant_API_Function" }, "x-found-in": "body" }, "connectorId": { "type": "string", "description": "A unique identifier for the connector.", "x-found-in": "body" }, "conversationId": { "type": "string", "description": "A unique identifier for the conversation if you are continuing an existing conversation.", "x-found-in": "body" }, "disableFunctions": { "type": "boolean", "description": "Flag indicating whether all function calls should be disabled for the conversation. If true, no calls to functions will be made.", "x-found-in": "body" }, "instructions": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Observability_AI_Assistant_API_Instruction" }, "description": "An array of instruction objects, which can be either simple strings or detailed objects.", "x-found-in": "body" }, "messages": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Observability_AI_Assistant_API_Message" }, "description": "An array of message objects containing the conversation history.", "x-found-in": "body" }, "persist": { "type": "boolean", "description": "Indicates whether the conversation should be saved to storage. If true, the conversation will be saved and will be available in Kibana.", "x-found-in": "body" }, "title": { "type": "string", "description": "A title for the conversation.", "x-found-in": "body" } }, "required": ["messages", "connectorId", "persist"] }

package/lib/cjs/kibana/json/roles.delete-security-role-name.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete-security-role-name", "x-api": { "id": "roles.delete-security-role-name", "name": "delete-security-role-name", "namespace": "roles" }, "x-method": "DELETE", "x-path": "/api/security/role/{name}", "x-destructive": true, "type": "object", "properties": { "name": { "type": "string", "description": "The role name.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/kibana/json/roles.get-security-role-name.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-security-role-name", "x-api": { "id": "roles.get-security-role-name", "name": "get-security-role-name", "namespace": "roles" }, "x-method": "GET", "x-path": "/api/security/role/{name}", "x-destructive": false, "type": "object", "properties": { "name": { "type": "string", "description": "The role name.", "x-found-in": "path" }, "replaceDeprecatedPrivileges": { "type": "boolean", "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.", "x-found-in": "query" } }, "required": ["name"] }

package/lib/cjs/kibana/json/roles.get-security-role.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-security-role", "x-api": { "id": "roles.get-security-role", "name": "get-security-role", "namespace": "roles" }, "x-method": "GET", "x-path": "/api/security/role", "x-destructive": false, "type": "object", "properties": { "replaceDeprecatedPrivileges": { "type": "boolean", "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.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/roles.post-security-roles.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-security-roles", "x-api": { "id": "roles.post-security-roles", "name": "post-security-roles", "namespace": "roles" }, "x-method": "POST", "x-path": "/api/security/roles", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_security_roles_bulk_create_or_update_payload", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/roles.put-security-role-name.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "put-security-role-name", "x-api": { "id": "roles.put-security-role-name", "name": "put-security-role-name", "namespace": "roles" }, "x-method": "PUT", "x-path": "/api/security/role/{name}", "x-destructive": true, "type": "object", "properties": { "name": { "type": "string", "description": "The role name.", "x-found-in": "path" }, "createOnly": { "type": "boolean", "description": "When true, a role is not overwritten if it already exists.", "x-found-in": "query" }, "body": { "$ref": "./_defs.json#/$defs/Kibana_HTTP_APIs_security_role_put_payload", "x-found-in": "body", "x-body-root": true } }, "required": ["name"] }

package/lib/cjs/kibana/json/saved-objects.post-saved-objects-export.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-saved-objects-export", "x-api": { "id": "saved-objects.post-saved-objects-export", "name": "post-saved-objects-export", "namespace": "saved-objects" }, "x-method": "POST", "x-path": "/api/saved_objects/_export", "x-destructive": true, "x-response-type": "ndjson", "type": "object", "properties": { "excludeExportDetails": { "type": "boolean", "description": "Do not add export details entry at the end of the stream.", "x-found-in": "body" }, "hasReference": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] } }], "x-found-in": "body" }, "includeReferencesDeep": { "type": "boolean", "description": "Includes all of the referenced objects in the exported objects.", "x-found-in": "body" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] }, "description": "A list of objects to export. NOTE: this optional parameter cannot be combined with the `types` option", "x-found-in": "body" }, "search": { "type": "string", "description": "Search for documents to export using the Elasticsearch Simple Query String syntax.", "x-found-in": "body" }, "type": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The saved object types to include in the export. Use `*` to export all the types. Valid options depend on enabled plugins, but may include `visualization`, `dashboard`, `search`, `index-pattern`, `tag`, `config`, `config-global`, `lens`, `map`, `event-annotation-group`, `query`, `url`, `action`, `alert`, `alerting_rule_template`, `apm-indices`, `cases-user-actions`, `cases`, `cases-comments`, `infrastructure-monitoring-log-view`, `ml-trained-model`, `osquery-saved-query`, `osquery-pack`, `osquery-pack-asset`.", "x-found-in": "body" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.chat-complete.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ChatComplete", "x-api": { "id": "security-ai-assistant-api.chat-complete", "name": "chat-complete", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/chat/complete", "x-destructive": false, "type": "object", "properties": { "content_references_disabled": { "type": "boolean", "description": "If true, the response will not include content references.", "x-found-in": "query" }, "body": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_ChatCompleteProps", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.create-conversation.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "CreateConversation", "x-api": { "id": "security-ai-assistant-api.create-conversation", "name": "create-conversation", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/current_user/conversations", "x-destructive": false, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_ConversationCreateProps", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.create-knowledge-base-entry.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "CreateKnowledgeBaseEntry", "x-api": { "id": "security-ai-assistant-api.create-knowledge-base-entry", "name": "create-knowledge-base-entry", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/knowledge_base/entries", "x-destructive": false, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_KnowledgeBaseEntryCreateProps", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.create-knowledge-base.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "CreateKnowledgeBase", "x-api": { "id": "security-ai-assistant-api.create-knowledge-base", "name": "create-knowledge-base", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/knowledge_base/{resource}", "x-destructive": false, "type": "object", "properties": { "resource": { "type": "string", "description": "The KnowledgeBase `resource` value.", "x-found-in": "path" }, "modelId": { "type": "string", "description": "ELSER modelId to use when setting up the Knowledge Base. If not provided, a default model will be used.", "x-found-in": "query" }, "ignoreSecurityLabs": { "type": "boolean", "description": "Indicates whether we should or should not install Security Labs docs when setting up the Knowledge Base. Defaults to `false`.", "x-found-in": "query" } }, "required": ["resource"] }

package/lib/cjs/kibana/json/security-ai-assistant-api.delete-all-conversations.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "DeleteAllConversations", "x-api": { "id": "security-ai-assistant-api.delete-all-conversations", "name": "delete-all-conversations", "namespace": "security-ai-assistant-api" }, "x-method": "DELETE", "x-path": "/api/security_ai_assistant/current_user/conversations", "x-destructive": true, "type": "object", "properties": { "excludedIds": { "type": "array", "items": { "type": "string" }, "description": "Optional list of conversation IDs to delete.", "x-found-in": "body" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.delete-conversation.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "DeleteConversation", "x-api": { "id": "security-ai-assistant-api.delete-conversation", "name": "delete-conversation", "namespace": "security-ai-assistant-api" }, "x-method": "DELETE", "x-path": "/api/security_ai_assistant/current_user/conversations/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The conversation's `id` value.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-ai-assistant-api.delete-knowledge-base-entry.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "DeleteKnowledgeBaseEntry", "x-api": { "id": "security-ai-assistant-api.delete-knowledge-base-entry", "name": "delete-knowledge-base-entry", "namespace": "security-ai-assistant-api" }, "x-method": "DELETE", "x-path": "/api/security_ai_assistant/knowledge_base/entries/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (`id`) of the Knowledge Base Entry to delete.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-ai-assistant-api.find-anonymization-fields.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindAnonymizationFields", "x-api": { "id": "security-ai-assistant-api.find-anonymization-fields", "name": "find-anonymization-fields", "namespace": "security-ai-assistant-api" }, "x-method": "GET", "x-path": "/api/security_ai_assistant/anonymization_fields/_find", "x-destructive": false, "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "Fields to return", "x-found-in": "query" }, "filter": { "type": "string", "description": "Search query", "x-found-in": "query" }, "sort_field": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_FindAnonymizationFieldsSortField", "description": "Field to sort by", "x-found-in": "query" }, "sort_order": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_SortOrder", "description": "Sort order", "x-found-in": "query" }, "page": { "type": "number", "description": "Page number", "x-found-in": "query" }, "per_page": { "type": "number", "description": "AnonymizationFields per page", "x-found-in": "query" }, "all_data": { "type": "boolean", "description": "If true, additionally fetch all anonymization fields, otherwise fetch only the provided page", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.find-conversations.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindConversations", "x-api": { "id": "security-ai-assistant-api.find-conversations", "name": "find-conversations", "namespace": "security-ai-assistant-api" }, "x-method": "GET", "x-path": "/api/security_ai_assistant/current_user/conversations/_find", "x-destructive": false, "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "A list of fields to include in the response. If omitted, all fields are returned.", "x-found-in": "query" }, "filter": { "type": "string", "description": "A search query to filter the conversations. Can match against titles, messages, or other conversation attributes.", "x-found-in": "query" }, "sort_field": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_FindConversationsSortField", "description": "The field by which to sort the results. Valid fields are `created_at`, `title`, and `updated_at`.", "x-found-in": "query" }, "sort_order": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_SortOrder", "description": "The order in which to sort the results. Can be either `asc` for ascending or `desc` for descending.", "x-found-in": "query" }, "page": { "type": "number", "description": "The page number of the results to retrieve. Default is 1.", "x-found-in": "query" }, "per_page": { "type": "number", "description": "The number of conversations to return per page. Default is 20.", "x-found-in": "query" }, "is_owner": { "type": "boolean", "description": "Whether to return conversations that the current user owns. If true, only conversations owned by the user are returned.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.find-knowledge-base-entries.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindKnowledgeBaseEntries", "x-api": { "id": "security-ai-assistant-api.find-knowledge-base-entries", "name": "find-knowledge-base-entries", "namespace": "security-ai-assistant-api" }, "x-method": "GET", "x-path": "/api/security_ai_assistant/knowledge_base/entries/_find", "x-destructive": false, "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "A list of fields to include in the response. If not provided, all fields will be included.", "x-found-in": "query" }, "filter": { "type": "string", "description": "Search query to filter Knowledge Base Entries by specific criteria.", "x-found-in": "query" }, "sort_field": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_FindKnowledgeBaseEntriesSortField", "description": "Field to sort the Knowledge Base Entries by.", "x-found-in": "query" }, "sort_order": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_SortOrder", "description": "Sort order for the results, either asc or desc.", "x-found-in": "query" }, "page": { "type": "number", "description": "Page number for paginated results. Defaults to 1.", "x-found-in": "query" }, "per_page": { "type": "number", "description": "Number of Knowledge Base Entries to return per page. Defaults to 20.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.find-prompts.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindPrompts", "x-api": { "id": "security-ai-assistant-api.find-prompts", "name": "find-prompts", "namespace": "security-ai-assistant-api" }, "x-method": "GET", "x-path": "/api/security_ai_assistant/prompts/_find", "x-destructive": false, "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "List of specific fields to include in each returned prompt.", "x-found-in": "query" }, "filter": { "type": "string", "description": "Search query string to filter prompts by matching fields.", "x-found-in": "query" }, "sort_field": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_FindPromptsSortField", "description": "Field to sort prompts by.", "x-found-in": "query" }, "sort_order": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_SortOrder", "description": "Sort order, either asc or desc.", "x-found-in": "query" }, "page": { "type": "number", "description": "Page number for pagination.", "x-found-in": "query" }, "per_page": { "type": "number", "description": "Number of prompts per page.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.perform-anonymization-fields-bulk-action.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PerformAnonymizationFieldsBulkAction", "x-api": { "id": "security-ai-assistant-api.perform-anonymization-fields-bulk-action", "name": "perform-anonymization-fields-bulk-action", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/anonymization_fields/_bulk_action", "x-destructive": true, "type": "object", "properties": { "create": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_AnonymizationFieldCreateProps" }, "description": "Array of anonymization fields to create.", "x-found-in": "body" }, "delete": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "Array of IDs to apply the action to." }, "query": { "type": "string", "description": "Query to filter the bulk action." } }, "description": "Object containing the query to filter anonymization fields and/or an array of anonymization field IDs to delete.", "x-found-in": "body" }, "update": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_AnonymizationFieldUpdateProps" }, "description": "Array of anonymization fields to update.", "x-found-in": "body" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.perform-knowledge-base-entry-bulk-action.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PerformKnowledgeBaseEntryBulkAction", "x-api": { "id": "security-ai-assistant-api.perform-knowledge-base-entry-bulk-action", "name": "perform-knowledge-base-entry-bulk-action", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/knowledge_base/entries/_bulk_action", "x-destructive": true, "type": "object", "properties": { "create": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_KnowledgeBaseEntryCreateProps" }, "description": "List of Knowledge Base Entries to create.", "x-found-in": "body" }, "delete": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "Array of Knowledge Base Entry IDs." }, "query": { "type": "string", "description": "Query to filter Knowledge Base Entries." } }, "x-found-in": "body" }, "update": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_KnowledgeBaseEntryUpdateProps" }, "description": "List of Knowledge Base Entries to update.", "x-found-in": "body" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.perform-prompts-bulk-action.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PerformPromptsBulkAction", "x-api": { "id": "security-ai-assistant-api.perform-prompts-bulk-action", "name": "perform-prompts-bulk-action", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/prompts/_bulk_action", "x-destructive": true, "type": "object", "properties": { "create": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_PromptCreateProps" }, "description": "List of prompts to be created.", "x-found-in": "body" }, "delete": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "Array of IDs to apply the action to." }, "query": { "type": "string", "description": "Query to filter the bulk action." } }, "description": "Criteria for deleting prompts in bulk.", "x-found-in": "body" }, "update": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_PromptUpdateProps" }, "description": "List of prompts to be updated.", "x-found-in": "body" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.post-knowledge-base.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PostKnowledgeBase", "x-api": { "id": "security-ai-assistant-api.post-knowledge-base", "name": "post-knowledge-base", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/knowledge_base", "x-destructive": false, "type": "object", "properties": { "modelId": { "type": "string", "description": "ELSER modelId to use when setting up the Knowledge Base. If not provided, a default model will be used.", "x-found-in": "query" }, "ignoreSecurityLabs": { "type": "boolean", "description": "Indicates whether we should or should not install Security Labs docs when setting up the Knowledge Base. Defaults to `false`.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-ai-assistant-api.read-conversation.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ReadConversation", "x-api": { "id": "security-ai-assistant-api.read-conversation", "name": "read-conversation", "namespace": "security-ai-assistant-api" }, "x-method": "GET", "x-path": "/api/security_ai_assistant/current_user/conversations/{id}", "x-destructive": false, "type": "object", "properties": { "id": { "type": "string", "description": "The conversation's `id` value, a unique identifier for the conversation.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-ai-assistant-api.read-knowledge-base-entry.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ReadKnowledgeBaseEntry", "x-api": { "id": "security-ai-assistant-api.read-knowledge-base-entry", "name": "read-knowledge-base-entry", "namespace": "security-ai-assistant-api" }, "x-method": "GET", "x-path": "/api/security_ai_assistant/knowledge_base/entries/{id}", "x-destructive": false, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (`id`) of the Knowledge Base Entry to retrieve.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-ai-assistant-api.read-knowledge-base.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ReadKnowledgeBase", "x-api": { "id": "security-ai-assistant-api.read-knowledge-base", "name": "read-knowledge-base", "namespace": "security-ai-assistant-api" }, "x-method": "GET", "x-path": "/api/security_ai_assistant/knowledge_base/{resource}", "x-destructive": false, "type": "object", "properties": { "resource": { "type": "string", "description": "The KnowledgeBase `resource` value.", "x-found-in": "path" } }, "required": ["resource"] }

package/lib/cjs/kibana/json/security-ai-assistant-api.update-conversation.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "UpdateConversation", "x-api": { "id": "security-ai-assistant-api.update-conversation", "name": "update-conversation", "namespace": "security-ai-assistant-api" }, "x-method": "PUT", "x-path": "/api/security_ai_assistant/current_user/conversations/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The conversation's `id` value.", "x-found-in": "path" }, "body": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_ConversationUpdateProps", "x-found-in": "body", "x-body-root": true } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-ai-assistant-api.update-knowledge-base-entry.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "UpdateKnowledgeBaseEntry", "x-api": { "id": "security-ai-assistant-api.update-knowledge-base-entry", "name": "update-knowledge-base-entry", "namespace": "security-ai-assistant-api" }, "x-method": "PUT", "x-path": "/api/security_ai_assistant/knowledge_base/entries/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (`id`) of the Knowledge Base Entry to update.", "x-found-in": "path" }, "body": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_KnowledgeBaseEntryUpdateRouteProps", "x-found-in": "body", "x-body-root": true } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-attack-discovery-api.attack-discovery-find.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "AttackDiscoveryFind", "x-api": { "id": "security-attack-discovery-api.attack-discovery-find", "name": "attack-discovery-find", "namespace": "security-attack-discovery-api" }, "x-method": "GET", "x-path": "/api/attack_discovery/_find", "x-destructive": false, "type": "object", "properties": { "alert_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter results to Attack discoveries that include any of the provided alert IDs", "x-found-in": "query" }, "connector_names": { "type": "array", "items": { "type": "string" }, "description": "Filter results to Attack discoveries created by any of the provided human readable connector names. Note that values must match the human readable `connector_name` property of an Attack discovery, e.g. \"GPT-5 Chat\", which are distinct from `connector_id` values used to generate Attack discoveries.", "x-found-in": "query" }, "enable_field_rendering": { "type": "boolean", "description": "Enables a markdown syntax used to render pivot fields, for example `{{ user.name james }}`. When disabled, the same example would be rendered as `james`. This is primarily used for Attack Discovery views within Kibana. Defaults to `false`.", "x-found-in": "query" }, "end": { "type": "string", "description": "End of the time range for the search. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now\", \"now-24h\").", "x-found-in": "query" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Filter results to the Attack discoveries with the specified IDs", "x-found-in": "query" }, "include_unique_alert_ids": { "type": "boolean", "description": "If `true`, the response will include `unique_alert_ids` and `unique_alert_ids_count` aggregated across the matched Attack discoveries", "x-found-in": "query" }, "page": { "type": "number", "description": "Page number to return (used for pagination). Defaults to 1.", "x-found-in": "query" }, "per_page": { "type": "number", "description": "Number of Attack discoveries to return per page (used for pagination). Defaults to 10.", "x-found-in": "query" }, "search": { "type": "string", "description": "Free-text search query applied to relevant text fields of Attack discoveries (title, description, tags, etc.)", "x-found-in": "query" }, "shared": { "type": "boolean", "description": "Whether to filter by shared visibility. If omitted, both shared and privately visible Attack discoveries are returned. Use `true` to return only shared discoveries, `false` to return only those visible to the current user. Mutually exclusive with `include_all_authors`.", "x-found-in": "query" }, "include_all_authors": { "type": "boolean", "description": "If `true`, the response will include all attack discoveries matching other criteria regardless of who created them. Mutually exclusive with `shared`.", "x-found-in": "query" }, "scheduled": { "type": "boolean", "description": "Whether to filter by scheduled or ad-hoc attack discoveries. If omitted, both types of attack discoveries are returned. Use `true` to return only scheduled discoveries or `false` to return only ad-hoc discoveries.", "x-found-in": "query" }, "sort_field": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_AttackDiscoveryFindSortField", "description": "Field used to sort results. See `AttackDiscoveryFindSortField` for allowed values.", "x-found-in": "query" }, "sort_order": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_SortOrder", "description": "Sort order direction `asc` for ascending or `desc` for descending. Defaults to `desc`.", "x-found-in": "query" }, "start": { "type": "string", "description": "Start of the time range for the search. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now-7d\").", "x-found-in": "query" }, "status": { "type": "array", "items": { "enum": ["acknowledged", "closed", "open"] }, "description": "Filter by alert workflow status. Provide one or more of the allowed workflow states.", "x-found-in": "query" }, "with_replacements": { "type": "boolean", "description": "When true, return the created Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. Defaults to `true`.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-attack-discovery-api.bulk-delete-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "BulkDeleteAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.bulk-delete-attack-discovery-schedules", "name": "bulk-delete-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/schedules/_bulk_delete", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_BulkActionAttackDiscoverySchedulesRequestBody", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-attack-discovery-api.bulk-disable-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "BulkDisableAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.bulk-disable-attack-discovery-schedules", "name": "bulk-disable-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/schedules/_bulk_disable", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_BulkActionAttackDiscoverySchedulesRequestBody", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-attack-discovery-api.bulk-enable-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "BulkEnableAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.bulk-enable-attack-discovery-schedules", "name": "bulk-enable-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/schedules/_bulk_enable", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_BulkActionAttackDiscoverySchedulesRequestBody", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-attack-discovery-api.create-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "CreateAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.create-attack-discovery-schedules", "name": "create-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/schedules", "x-destructive": false, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_AttackDiscoveryApiScheduleCreateProps", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-attack-discovery-api.delete-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "DeleteAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.delete-attack-discovery-schedules", "name": "delete-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "DELETE", "x-path": "/api/attack_discovery/schedules/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (UUID) of the Attack Discovery schedule to delete. This ID is returned when creating a schedule and can be found in schedule listings.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-attack-discovery-api.disable-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "DisableAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.disable-attack-discovery-schedules", "name": "disable-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/schedules/{id}/_disable", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (UUID) of the Attack Discovery schedule to disable. This ID is returned when creating a schedule and can be found in schedule listings.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-attack-discovery-api.enable-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "EnableAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.enable-attack-discovery-schedules", "name": "enable-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/schedules/{id}/_enable", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (UUID) of the Attack Discovery schedule to enable. This ID is returned when creating a schedule and can be found in schedule listings.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-attack-discovery-api.find-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.find-attack-discovery-schedules", "name": "find-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "GET", "x-path": "/api/attack_discovery/schedules/_find", "x-destructive": false, "type": "object", "properties": { "page": { "type": "number", "description": "Page number to return (used for pagination). Defaults to 1.", "x-found-in": "query" }, "per_page": { "type": "number", "description": "Number of Attack Discovery schedules to return per page (used for pagination). Defaults to 10.", "x-found-in": "query" }, "sort_field": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_NonEmptyString", "description": "Field used to sort results. Common fields include 'name', 'created_at', 'updated_at', and 'enabled'.", "x-found-in": "query" }, "sort_direction": { "enum": ["asc", "desc"], "description": "Sort order direction. Use 'asc' for ascending or 'desc' for descending. Defaults to 'asc'.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-attack-discovery-api.get-attack-discovery-generation.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetAttackDiscoveryGeneration", "x-api": { "id": "security-attack-discovery-api.get-attack-discovery-generation", "name": "get-attack-discovery-generation", "namespace": "security-attack-discovery-api" }, "x-method": "GET", "x-path": "/api/attack_discovery/generations/{execution_uuid}", "x-destructive": false, "type": "object", "properties": { "execution_uuid": { "type": "string", "description": "The unique identifier for the Attack Discovery generation execution. This UUID is returned at the start of an Attack Discovery generation.", "x-found-in": "path" }, "enable_field_rendering": { "type": "boolean", "description": "Enables a markdown syntax used to render pivot fields, for example `{{ user.name james }}`. When disabled, the same example would be rendered as `james`. This is primarily used for Attack Discovery views within Kibana. Defaults to `false`.", "x-found-in": "query" }, "with_replacements": { "type": "boolean", "description": "When true, return the created Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. Defaults to `true`.", "x-found-in": "query" } }, "required": ["execution_uuid"] }

package/lib/cjs/kibana/json/security-attack-discovery-api.get-attack-discovery-generations.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetAttackDiscoveryGenerations", "x-api": { "id": "security-attack-discovery-api.get-attack-discovery-generations", "name": "get-attack-discovery-generations", "namespace": "security-attack-discovery-api" }, "x-method": "GET", "x-path": "/api/attack_discovery/generations", "x-destructive": false, "type": "object", "properties": { "end": { "type": "string", "description": "End of the time range for filtering generations. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now\", \"now-24h\").", "x-found-in": "query" }, "size": { "type": "number", "description": "The maximum number of generations to retrieve", "x-found-in": "query" }, "start": { "type": "string", "description": "Start of the time range for filtering generations. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now-7d\").", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-attack-discovery-api.get-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.get-attack-discovery-schedules", "name": "get-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "GET", "x-path": "/api/attack_discovery/schedules/{id}", "x-destructive": false, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (UUID) of the Attack Discovery schedule to retrieve. This ID is returned when creating a schedule and can be found in schedule listings.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-attack-discovery-api.post-attack-discovery-bulk.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PostAttackDiscoveryBulk", "x-api": { "id": "security-attack-discovery-api.post-attack-discovery-bulk", "name": "post-attack-discovery-bulk", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/_bulk", "x-destructive": true, "type": "object", "properties": { "update": { "type": "object", "properties": { "enable_field_rendering": { "type": "boolean", "description": "Enables a markdown syntax used to render pivot fields, for example `{{ user.name james }}`. When disabled, the same example would be rendered as `james`. This is primarily used for Attack Discovery views within Kibana. Defaults to `false`." }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Array of Attack Discovery IDs to update" }, "kibana_alert_workflow_status": { "enum": ["open", "acknowledged", "closed"], "description": "When provided, update the kibana.alert.workflow_status of the attack discovery alerts" }, "visibility": { "enum": ["not_shared", "shared"], "description": "When provided, update the visibility of the alert, as determined by the kibana.alert.attack_discovery.users field" }, "with_replacements": { "type": "boolean", "description": "When true, returns the updated Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. This substitutes anonymized values with human-readable equivalents. Defaults to `true`." } }, "required": ["ids"], "description": "Configuration object containing all parameters for the bulk update operation", "x-found-in": "body" } }, "required": ["update"] }

package/lib/cjs/kibana/json/security-attack-discovery-api.post-attack-discovery-generate.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PostAttackDiscoveryGenerate", "x-api": { "id": "security-attack-discovery-api.post-attack-discovery-generate", "name": "post-attack-discovery-generate", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/_generate", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_AttackDiscoveryGenerationConfig", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-attack-discovery-api.post-attack-discovery-generations-dismiss.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PostAttackDiscoveryGenerationsDismiss", "x-api": { "id": "security-attack-discovery-api.post-attack-discovery-generations-dismiss", "name": "post-attack-discovery-generations-dismiss", "namespace": "security-attack-discovery-api" }, "x-method": "POST", "x-path": "/api/attack_discovery/generations/{execution_uuid}/_dismiss", "x-destructive": true, "type": "object", "properties": { "execution_uuid": { "type": "string", "description": "The unique identifier for the Attack Discovery generation execution. This UUID is returned when an Attack Discovery generation is created and can be found in generation responses.", "x-found-in": "path" } }, "required": ["execution_uuid"] }

package/lib/cjs/kibana/json/security-attack-discovery-api.update-attack-discovery-schedules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "UpdateAttackDiscoverySchedules", "x-api": { "id": "security-attack-discovery-api.update-attack-discovery-schedules", "name": "update-attack-discovery-schedules", "namespace": "security-attack-discovery-api" }, "x-method": "PUT", "x-path": "/api/attack_discovery/schedules/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (UUID) of the Attack Discovery schedule to update. This ID is returned when creating a schedule and can be found in schedule listings.", "x-found-in": "path" }, "body": { "$ref": "./_defs.json#/$defs/Security_Attack_discovery_API_AttackDiscoveryApiScheduleUpdateProps", "x-found-in": "body", "x-body-root": true } }, "required": ["id"] }

package/lib/cjs/kibana/json/security-detections-api.create-rule.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "CreateRule", "x-api": { "id": "security-detections-api.create-rule", "name": "create-rule", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/rules", "x-destructive": false, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleCreateProps", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-detections-api.delete-rule.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "DeleteRule", "x-api": { "id": "security-detections-api.delete-rule", "name": "delete-rule", "namespace": "security-detections-api" }, "x-method": "DELETE", "x-path": "/api/detection_engine/rules", "x-destructive": true, "type": "object", "properties": { "id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_UUID", "description": "The rule's `id` value.", "x-found-in": "query" }, "rule_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleSignatureId", "description": "The rule's `rule_id` value.", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-detections-api.export-rules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportRules", "x-api": { "id": "security-detections-api.export-rules", "name": "export-rules", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/rules/_export", "x-destructive": true, "x-response-type": "ndjson", "type": "object", "properties": { "exclude_export_details": { "type": "boolean", "description": "Determines whether a summary of the exported rules is returned.", "x-found-in": "query" }, "file_name": { "type": "string", "description": "File name for saving the exported rules.\n> info\n> When using cURL to export rules to a file, use the -O and -J options to save the rules to the file name specified in the URL.\n", "x-found-in": "query" }, "body": { "oneOf": [{ "type": "object", "properties": { "objects": { "type": "array", "items": { "type": "object", "properties": { "rule_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleSignatureId" } }, "required": ["rule_id"] }, "description": "Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified." } }, "required": ["objects"] }, { "type": "null" }], "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-detections-api.find-rules.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindRules", "x-api": { "id": "security-detections-api.find-rules", "name": "find-rules", "namespace": "security-detections-api" }, "x-method": "GET", "x-path": "/api/detection_engine/rules/_find", "x-destructive": false, "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "List of `alert.attributes` field names to return for each rule (for example `name`, `enabled`).\nIf omitted, the default field set is returned. Repeat the parameter to pass multiple field names, or\nuse comma-separated values when supported by your client.\n", "x-found-in": "query" }, "filter": { "type": "string", "description": "Search query\n\nFilters the returned results according to the value of the specified field, using the alert.attributes.<field name>:<field value> syntax, where <field name> can be:\n- name\n- enabled\n- tags\n- createdBy\n- interval\n- updatedBy\n> info\n> Even though the JSON rule object uses created_by and updated_by fields, you must use createdBy and updatedBy fields in the filter.\n", "x-found-in": "query" }, "sort_field": { "$ref": "./_defs.json#/$defs/Security_Detections_API_FindRulesSortField", "description": "Field to sort by", "x-found-in": "query" }, "sort_order": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SortOrder", "description": "Sort order", "x-found-in": "query" }, "page": { "type": "number", "description": "Page number", "x-found-in": "query" }, "per_page": { "type": "number", "description": "Rules per page", "x-found-in": "query" }, "gaps_range_start": { "type": "string", "description": "Gaps range start", "x-found-in": "query" }, "gaps_range_end": { "type": "string", "description": "Gaps range end", "x-found-in": "query" }, "gap_fill_statuses": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_GapFillStatus" }, "description": "Gap fill statuses", "x-found-in": "query" }, "gap_auto_fill_scheduler_id": { "type": "string", "description": "Gap auto fill scheduler ID used to determine gap fill status for rules", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-detections-api.patch-rule.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PatchRule", "x-api": { "id": "security-detections-api.patch-rule", "name": "patch-rule", "namespace": "security-detections-api" }, "x-method": "PATCH", "x-path": "/api/detection_engine/rules", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RulePatchProps", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-detections-api.perform-rules-bulk-action.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "PerformRulesBulkAction", "x-api": { "id": "security-detections-api.perform-rules-bulk-action", "name": "perform-rules-bulk-action", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/rules/_bulk_action", "x-destructive": true, "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "Enables dry run mode for the request call.\n\nEnable dry run mode to verify that bulk actions can be applied to specified rules. Certain rules, such as prebuilt Elastic rules on a Basic subscription, can’t be edited and will return errors in the request response. Error details will contain an explanation, the rule name and/or ID, and additional troubleshooting information.\n\nTo enable dry run mode on a request, add the query parameter `dry_run=true` to the end of the request URL. Rules specified in the request will be temporarily updated. These updates won’t be written to Elasticsearch.\n> info\n> Dry run mode is not supported for the `export` bulk action. A 400 error will be returned in the request response.\n", "x-found-in": "query" }, "action": { "enum": ["edit"], "x-found-in": "body" }, "gap_auto_fill_scheduler_id": { "type": "string", "description": "Gap auto fill scheduler ID used to determine gap fill status for rules", "x-found-in": "body" }, "gap_fill_statuses": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_GapFillStatus" }, "description": "Gap fill statuses to filter rules with gaps by status (used together with gaps_range_*).", "x-found-in": "body" }, "gaps_range_end": { "type": "string", "description": "Gaps range end, valid only when query is provided", "x-found-in": "body" }, "gaps_range_start": { "type": "string", "description": "Gaps range start, valid only when query is provided", "x-found-in": "body" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.\nOnly valid when query property is undefined.\n", "x-found-in": "body" }, "query": { "type": "string", "description": "Query to filter rules.", "x-found-in": "body" }, "duplicate": { "type": "object", "properties": { "include_exceptions": { "type": "boolean", "description": "Whether to copy exceptions from the original rule" }, "include_expired_exceptions": { "type": "boolean", "description": "Whether to copy expired exceptions from the original rule" } }, "required": ["include_exceptions", "include_expired_exceptions"], "description": "Duplicate object that describes applying an update action.", "x-found-in": "body" }, "run": { "type": "object", "properties": { "end_date": { "type": "string", "description": "End date of the manual rule run" }, "start_date": { "type": "string", "description": "Start date of the manual rule run" } }, "required": ["start_date", "end_date"], "description": "Object that describes applying a manual rule run action.", "x-found-in": "body" }, "fill_gaps": { "type": "object", "properties": { "end_date": { "type": "string", "description": "End date of the manual gap fill" }, "start_date": { "type": "string", "description": "Start date of the manual gap fill" } }, "required": ["start_date", "end_date"], "description": "Object that describes applying a manual gap fill action for the specified time range.", "x-found-in": "body" }, "edit": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_BulkActionEditPayload" }, "description": "Array of objects containing the edit operations", "x-found-in": "body" } }, "required": ["action"] }

package/lib/cjs/kibana/json/security-detections-api.read-rule.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ReadRule", "x-api": { "id": "security-detections-api.read-rule", "name": "read-rule", "namespace": "security-detections-api" }, "x-method": "GET", "x-path": "/api/detection_engine/rules", "x-destructive": false, "type": "object", "properties": { "id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_UUID", "description": "The rule's `id` value.", "x-found-in": "query" }, "rule_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleSignatureId", "description": "The rule's `rule_id` value.", "x-found-in": "query" } } }