@elastic/schemas 0.4.5 → 0.5.0

package/lib/cjs/kibana/json/export_exception_list.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "Exception list's internal `id` (UUID) returned on create; use with `list_id` and `namespace_type` for an unambiguous target.", "x-found-in": "query" }, "list_id": { "type": "string", "description": "Human-readable `list_id` of the exception list to export, as shown in the UI and API responses.", "x-found-in": "query" }, "namespace_type": { "type": "string", "description": "`single` exports a list in the current Kibana space; `agnostic` exports a global (space-agnostic) list.", "x-found-in": "query" }, "include_expired_exceptions": { "type": "string", "description": "Determines whether to include expired exceptions in the exported list. Expiration date defined by `expire_time`.", "x-found-in": "query" } }, "required": ["id", "list_id", "namespace_type", "include_expired_exceptions"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportExceptionList" }

package/lib/cjs/kibana/json/export_list_items.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "list_id": { "type": "string", "description": "Value list's `id` to export.", "x-found-in": "query" } }, "required": ["list_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportListItems" }

package/lib/cjs/kibana/json/export_rules.request.json

@@ -0,0 +1 @@
+{ "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.", "x-found-in": "query" } }, "allOf": [{ "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" }] }], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportRules" }

package/lib/cjs/kibana/json/export_timelines.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the file to export", "x-found-in": "query" } }, "required": ["file_name"], "allOf": [{ "type": "object", "properties": { "ids": { "oneOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }] } } }], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportTimelines" }

package/lib/cjs/kibana/json/find_anonymization_fields.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "fields": { "type": "string", "description": "Fields to return", "x-found-in": "query" }, "filter": { "type": "string", "description": "Search query", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Field to sort by", "x-found-in": "query" }, "sort_order": { "type": "string", "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindAnonymizationFields" }

package/lib/cjs/kibana/json/find_asset_criticality_records.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "sort_field": { "type": "string", "description": "The field to sort by.", "x-found-in": "query" }, "sort_direction": { "type": "string", "description": "The order to sort by.", "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 records to return per page.", "x-found-in": "query" }, "kuery": { "type": "string", "description": "The kuery to filter by.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindAssetCriticalityRecords" }

package/lib/cjs/kibana/json/find_attack_discovery_schedules.request.json

@@ -0,0 +1 @@
+{ "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": { "type": "string", "description": "Field used to sort results. Common fields include 'name', 'created_at', 'updated_at', and 'enabled'.", "x-found-in": "query" }, "sort_direction": { "type": "string", "description": "Sort order direction. Use 'asc' for ascending or 'desc' for descending. Defaults to 'asc'.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindAttackDiscoverySchedules" }

package/lib/cjs/kibana/json/find_conversations.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "fields": { "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": { "type": "string", "description": "The field by which to sort the results. Valid fields are `created_at`, `title`, and `updated_at`.", "x-found-in": "query" }, "sort_order": { "type": "string", "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindConversations" }

package/lib/cjs/kibana/json/find_endpoint_list_items.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "filter": { "type": "string", "description": "Filters the returned results according to the value of the specified field,", "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 exception list items to return per page", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Determines which field is used to sort the results", "x-found-in": "query" }, "sort_order": { "type": "string", "description": "Determines the sort order, which can be `desc` or `asc`", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindEndpointListItems" }

package/lib/cjs/kibana/json/find_exception_list_items.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "list_id": { "type": "string", "description": "The `list_id`s of the items to fetch.", "x-found-in": "query" }, "filter": { "type": "string", "description": "Filters the returned results according to the value of the specified field,", "x-found-in": "query" }, "namespace_type": { "type": "string", "description": "Determines whether the returned containers are Kibana associated with a Kibana space", "x-found-in": "query" }, "search": { "type": "string", "description": "Free-text search term applied to exception list item fields (for example a hostname or file path fragment).", "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 exception list items to return per page", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Determines which field is used to sort the results.", "x-found-in": "query" }, "sort_order": { "type": "string", "description": "Determines the sort order, which can be `desc` or `asc`.", "x-found-in": "query" } }, "required": ["list_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindExceptionListItems" }

package/lib/cjs/kibana/json/find_exception_lists.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "filter": { "type": "string", "description": "Filters the returned results according to the value of the specified field.", "x-found-in": "query" }, "namespace_type": { "type": "string", "description": "Determines whether the returned containers are Kibana associated with a Kibana space", "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 exception lists to return per page", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Determines which field is used to sort the results.", "x-found-in": "query" }, "sort_order": { "type": "string", "description": "Determines the sort order, which can be `desc` or `asc`.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindExceptionLists" }

package/lib/cjs/kibana/json/find_knowledge_base_entries.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "fields": { "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": { "type": "string", "description": "Field to sort the Knowledge Base Entries by.", "x-found-in": "query" }, "sort_order": { "type": "string", "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindKnowledgeBaseEntries" }

package/lib/cjs/kibana/json/find_list_items.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "list_id": { "type": "string", "description": "Parent value list's `id` to page through items for.", "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 list items to return per page.", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Determines which field is used to sort the results.", "x-found-in": "query" }, "sort_order": { "type": "string", "description": "Determines the sort order, which can be `desc` or `asc`", "x-found-in": "query" }, "cursor": { "type": "string", "description": "Opaque cursor returned in a previous response; pass it to continue listing from the next page. Omit on the first request.", "x-found-in": "query" }, "filter": { "type": "string", "description": "Filters the returned results according to the value of the specified field,", "x-found-in": "query" } }, "required": ["list_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindListItems" }

package/lib/cjs/kibana/json/find_lists.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "page": { "type": "number", "description": "The page number to return.", "x-found-in": "query" }, "per_page": { "type": "number", "description": "The number of value lists to return per page.", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Determines which field is used to sort the results.", "x-found-in": "query" }, "sort_order": { "type": "string", "description": "Determines the sort order, which can be `desc` or `asc`", "x-found-in": "query" }, "cursor": { "type": "string", "description": "Returns the lists that come after the last lists returned in the previous call (use the `cursor` value returned in the previous call). This parameter uses the `tie_breaker_id` field to ensure all lists are sorted and returned correctly.", "x-found-in": "query" }, "filter": { "type": "string", "description": "Filters the returned results according to the value of the specified field,", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindLists" }

package/lib/cjs/kibana/json/find_prompts.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "fields": { "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": { "type": "string", "description": "Field to sort prompts by.", "x-found-in": "query" }, "sort_order": { "type": "string", "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindPrompts" }

package/lib/cjs/kibana/json/find_rules.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "fields": { "type": "string", "description": "List of `alert.attributes` field names to return for each rule (for example `name`, `enabled`).", "x-found-in": "query" }, "filter": { "type": "string", "description": "Search query", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Field to sort by", "x-found-in": "query" }, "sort_order": { "type": "string", "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": "string", "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindRules" }

package/lib/cjs/kibana/json/find_slos_op.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "spaceId": { "type": "string", "description": "The spaceId parameter", "x-found-in": "path" }, "kqlQuery": { "type": "string", "description": "A valid kql query to filter the SLO with", "x-found-in": "query" }, "size": { "type": "number", "description": "The page size to use for cursor-based pagination, must be greater or equal than 1", "x-found-in": "query" }, "searchAfter": { "type": "string", "description": "The cursor to use for fetching the results from, when using a cursor-base pagination.", "x-found-in": "query" }, "page": { "type": "number", "description": "The page to use for pagination, must be greater or equal than 1", "x-found-in": "query" }, "perPage": { "type": "number", "description": "Number of SLOs returned by page", "x-found-in": "query" }, "sortBy": { "type": "string", "description": "Sort by field", "x-found-in": "query" }, "sortDirection": { "type": "string", "description": "Sort order", "x-found-in": "query" }, "hideStale": { "type": "boolean", "description": "Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings", "x-found-in": "query" } }, "required": ["spaceId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "findSlosOp" }

package/lib/cjs/kibana/json/get_actions_connector_id.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "An identifier for the connector.", "x-found-in": "path" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-actions-connector-id" }

package/lib/cjs/kibana/json/get_actions_connector_oauth_callback.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "code": { "type": "string", "description": "The authorization code returned by the OAuth provider.", "x-found-in": "query" }, "state": { "type": "string", "description": "The state parameter for CSRF protection.", "x-found-in": "query" }, "error": { "type": "string", "description": "Error code if the authorization failed.", "x-found-in": "query" }, "error_description": { "type": "string", "description": "Human-readable error description.", "x-found-in": "query" }, "session_state": { "type": "string", "description": "Session state from the OAuth provider (e.g., Microsoft).", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-actions-connector-oauth-callback" }

package/lib/cjs/kibana/json/get_actions_connector_types.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "feature_id": { "type": "string", "description": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-actions-connector-types" }

package/lib/cjs/kibana/json/get_agent_builder_a2a_agentid.json.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentId": { "type": "string", "description": "The unique identifier of the agent to get A2A metadata for.", "x-found-in": "path" } }, "required": ["agentId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-a2a-agentid.json" }

package/lib/cjs/kibana/json/get_agent_builder_agents_id.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the agent to retrieve.", "x-found-in": "path" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-agents-id" }

package/lib/cjs/kibana/json/get_agent_builder_agents_id_acl.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the agent whose ACL to retrieve.", "x-found-in": "path" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-agents-id-acl" }

package/lib/cjs/kibana/json/get_agent_builder_conversations.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agent_id": { "type": "string", "description": "Optional agent ID to filter conversations by a specific agent.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-conversations" }

package/lib/cjs/kibana/json/get_agent_builder_conversations_conversation_id.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "conversation_id": { "type": "string", "description": "The unique identifier of the conversation to retrieve.", "x-found-in": "path" } }, "required": ["conversation_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-conversations-conversation-id" }

package/lib/cjs/kibana/json/get_agent_builder_conversations_conversation_id_attachments.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "conversation_id": { "type": "string", "description": "The unique identifier of the conversation.", "x-found-in": "path" }, "include_deleted": { "type": "boolean", "description": "Whether to include deleted attachments in the list.", "x-found-in": "query" } }, "required": ["conversation_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-conversations-conversation-id-attachments" }

package/lib/cjs/kibana/json/get_agent_builder_conversations_conversation_id_attachments_stale.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "conversation_id": { "type": "string", "description": "The unique identifier of the conversation.", "x-found-in": "path" } }, "required": ["conversation_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-conversations-conversation-id-attachments-stale" }

package/lib/cjs/kibana/json/get_agent_builder_plugins_pluginid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "pluginId": { "type": "string", "description": "The unique identifier of the plugin.", "x-found-in": "path" } }, "required": ["pluginId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-plugins-pluginid" }

package/lib/cjs/kibana/json/get_agent_builder_skills.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "include_plugins": { "type": "boolean", "description": "Set to true to include skills from plugins.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-skills" }

package/lib/cjs/kibana/json/get_agent_builder_skills_skillid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "skillId": { "type": "string", "description": "The unique identifier of the skill.", "x-found-in": "path" } }, "required": ["skillId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-skills-skillid" }

package/lib/cjs/kibana/json/get_agent_builder_tools_toolid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "toolId": { "type": "string", "description": "The unique identifier of the tool to retrieve.", "x-found-in": "path" } }, "required": ["toolId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-agent-builder-tools-toolid" }

package/lib/cjs/kibana/json/get_agent_name_for_service.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "serviceName": { "type": "string", "description": "The name of the service", "x-found-in": "query" } }, "required": ["serviceName"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getAgentNameForService" }

package/lib/cjs/kibana/json/get_alerting_rule_id.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the rule.", "x-found-in": "path" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-alerting-rule-id" }

package/lib/cjs/kibana/json/get_alerting_rule_id_query_inspector.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the rule.", "x-found-in": "path" }, "mode": { "type": "string", "description": "The inspection mode. Use \"build\" to return only the query, or \"execute\" to run the query and include the response.", "x-found-in": "query" }, "alert_id": { "type": "string", "description": "The alert document ID. When provided, the query inspector uses the evaluation time range from the alert instead of the current time.", "x-found-in": "query" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-alerting-rule-id-query-inspector" }

package/lib/cjs/kibana/json/get_alerting_rules_backfill_id.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the backfill.", "x-found-in": "path" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-alerting-rules-backfill-id" }

package/lib/cjs/kibana/json/get_alerting_rules_find.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "per_page": { "type": "number", "description": "The number of rules to return per page.", "x-found-in": "query" }, "page": { "type": "number", "description": "The page number to return.", "x-found-in": "query" }, "search": { "type": "string", "description": "An Elasticsearch simple_query_string query that filters the objects in the response.", "x-found-in": "query" }, "default_search_operator": { "type": "string", "description": "The default operator to use for the simple_query_string.", "x-found-in": "query" }, "search_fields": { "type": "string", "description": "The fields to perform the simple_query_string parsed query against.", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Determines which field is used to sort the results. The field must exist in the `attributes` key of the response.", "x-found-in": "query" }, "sort_order": { "type": "string", "description": "Determines the sort order.", "x-found-in": "query" }, "has_reference": { "type": "string", "description": "Filters the rules that have a relation with the reference objects with a specific type and identifier.", "x-found-in": "query" }, "fields": { "type": "string", "description": "The fields to return in the `attributes` key of the response.", "x-found-in": "query" }, "filter": { "type": "string", "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`.", "x-found-in": "query" }, "filter_consumers": { "type": "string", "description": "", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-alerting-rules-find" }

package/lib/cjs/kibana/json/get_annotation.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "serviceName": { "type": "string", "description": "The name of the service", "x-found-in": "path" }, "environment": { "type": "string", "description": "The environment to filter annotations by", "x-found-in": "query" }, "start": { "type": "string", "description": "The start date for the search", "x-found-in": "query" }, "end": { "type": "string", "description": "The end date for the search", "x-found-in": "query" } }, "required": ["serviceName"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getAnnotation" }

package/lib/cjs/kibana/json/get_asset_criticality_record.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id_value": { "type": "string", "description": "The ID value of the asset.", "x-found-in": "query" }, "id_field": { "type": "string", "description": "The field representing the ID.", "x-found-in": "query" } }, "required": ["id_value", "id_field"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetAssetCriticalityRecord" }

package/lib/cjs/kibana/json/get_attack_discovery_generation.request.json

@@ -0,0 +1 @@
+{ "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"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetAttackDiscoveryGeneration" }

package/lib/cjs/kibana/json/get_attack_discovery_generations.request.json

@@ -0,0 +1 @@
+{ "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetAttackDiscoveryGenerations" }

package/lib/cjs/kibana/json/get_attack_discovery_schedules.request.json

@@ -0,0 +1 @@
+{ "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"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetAttackDiscoverySchedules" }

package/lib/cjs/kibana/json/get_dashboard_redirect.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "The id parameter", "x-found-in": "path" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-dashboard-redirect" }

package/lib/cjs/kibana/json/get_data_view_default.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "viewId": { "type": "string", "description": "The viewId parameter", "x-found-in": "path" } }, "required": ["viewId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getDataViewDefault" }

package/lib/cjs/kibana/json/get_definitions_op.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "spaceId": { "type": "string", "description": "The spaceId parameter", "x-found-in": "path" }, "includeOutdatedOnly": { "type": "boolean", "description": "Indicates if the API returns only outdated SLO or all SLO definitions", "x-found-in": "query" }, "includeHealth": { "type": "boolean", "description": "Indicates if the API returns SLO health data with definitions", "x-found-in": "query" }, "tags": { "type": "string", "description": "Filters the SLOs by tag", "x-found-in": "query" }, "search": { "type": "string", "description": "Filters the SLOs by name", "x-found-in": "query" }, "page": { "type": "number", "description": "The page to use for pagination, must be greater or equal than 1", "x-found-in": "query" }, "perPage": { "type": "number", "description": "Number of SLOs returned by page", "x-found-in": "query" } }, "required": ["spaceId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getDefinitionsOp" }

package/lib/cjs/kibana/json/get_draft_timelines.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "timelineType": { "type": "string", "description": "Which draft to load (`default` investigation timeline or `template` timeline template).", "x-found-in": "query" } }, "required": ["timelineType"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetDraftTimelines" }

package/lib/cjs/kibana/json/get_endpoint_metadata.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "The agent ID of the endpoint.", "x-found-in": "path" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetEndpointMetadata" }

package/lib/cjs/kibana/json/get_endpoint_metadata_list.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "page": { "type": "number", "description": "The page number to return.", "x-found-in": "query" }, "pageSize": { "type": "number", "description": "The number of endpoints to return per page.", "x-found-in": "query" }, "kuery": { "type": "string", "description": "A KQL string to filter the endpoint metadata results.", "x-found-in": "query" }, "hostStatuses": { "type": "string", "description": "A set of host statuses to filter the results by (for example, `healthy`, `updating`).", "x-found-in": "query" }, "sortField": { "type": "string", "description": "The field used to sort the results.", "x-found-in": "query" }, "sortDirection": { "type": "string", "description": "The sort order, either `asc` or `desc`.", "x-found-in": "query" } }, "required": ["hostStatuses"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetEndpointMetadataList" }

package/lib/cjs/kibana/json/get_entity_engine.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "entityType": { "type": "string", "description": "The entity type of the engine.", "x-found-in": "path" } }, "required": ["entityType"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetEntityEngine" }

package/lib/cjs/kibana/json/get_entity_store_status.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "include_components": { "type": "boolean", "description": "If true, returns a detailed status of each engine including all its components.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetEntityStoreStatus" }

package/lib/cjs/kibana/json/get_environments_for_service.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "serviceName": { "type": "string", "description": "The name of the service. If omitted, environments across all services are returned.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getEnvironmentsForService" }

package/lib/cjs/kibana/json/get_fleet_agent_download_sources_sourceid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "sourceId": { "type": "string", "description": "The ID of the download source", "x-found-in": "path" } }, "required": ["sourceId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-download-sources-sourceid" }

package/lib/cjs/kibana/json/get_fleet_agent_policies.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "page": { "type": "number", "description": "Page number", "x-found-in": "query" }, "perPage": { "type": "number", "description": "Number of results per page", "x-found-in": "query" }, "sortField": { "type": "string", "description": "Field to sort results by", "x-found-in": "query" }, "sortOrder": { "type": "string", "description": "Sort order, ascending or descending", "x-found-in": "query" }, "showUpgradeable": { "type": "boolean", "description": "When true, only show policies with upgradeable agents", "x-found-in": "query" }, "kuery": { "type": "string", "description": "A KQL query string to filter results", "x-found-in": "query" }, "noAgentCount": { "type": "boolean", "description": "use withAgentCount instead", "x-found-in": "query" }, "withAgentCount": { "type": "boolean", "description": "get policies with agent count", "x-found-in": "query" }, "full": { "type": "boolean", "description": "get full policies with package policies populated", "x-found-in": "query" }, "format": { "type": "string", "description": "Format for the response: simplified or legacy", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-policies" }

package/lib/cjs/kibana/json/get_fleet_agent_policies_agentpolicyid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentPolicyId": { "type": "string", "description": "The ID of the agent policy", "x-found-in": "path" }, "format": { "type": "string", "description": "Format for the response: simplified or legacy", "x-found-in": "query" } }, "required": ["agentPolicyId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-policies-agentpolicyid" }

package/lib/cjs/kibana/json/get_fleet_agent_policies_agentpolicyid_auto_upgrade_agents_status.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentPolicyId": { "type": "string", "description": "The ID of the agent policy", "x-found-in": "path" } }, "required": ["agentPolicyId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-policies-agentpolicyid-auto-upgrade-agents-status" }

package/lib/cjs/kibana/json/get_fleet_agent_policies_agentpolicyid_download.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentPolicyId": { "type": "string", "description": "The ID of the agent policy", "x-found-in": "path" }, "download": { "type": "boolean", "description": "If true, returns the policy as a downloadable file", "x-found-in": "query" }, "standalone": { "type": "boolean", "description": "If true, returns the policy formatted for standalone agents", "x-found-in": "query" }, "kubernetes": { "type": "boolean", "description": "If true, returns the policy formatted for Kubernetes deployment", "x-found-in": "query" }, "revision": { "type": "number", "description": "If provided, returns the policy at the specified revision. Cannot be used with standalone or kubernetes flags.", "x-found-in": "query" } }, "required": ["agentPolicyId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-policies-agentpolicyid-download" }

package/lib/cjs/kibana/json/get_fleet_agent_policies_agentpolicyid_full.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentPolicyId": { "type": "string", "description": "The ID of the agent policy", "x-found-in": "path" }, "download": { "type": "boolean", "description": "If true, returns the policy as a downloadable file", "x-found-in": "query" }, "standalone": { "type": "boolean", "description": "If true, returns the policy formatted for standalone agents", "x-found-in": "query" }, "kubernetes": { "type": "boolean", "description": "If true, returns the policy formatted for Kubernetes deployment", "x-found-in": "query" }, "revision": { "type": "number", "description": "If provided, returns the policy at the specified revision. Cannot be used with standalone or kubernetes flags.", "x-found-in": "query" } }, "required": ["agentPolicyId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-policies-agentpolicyid-full" }

package/lib/cjs/kibana/json/get_fleet_agent_policies_agentpolicyid_outputs.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentPolicyId": { "type": "string", "description": "The ID of the agent policy", "x-found-in": "path" } }, "required": ["agentPolicyId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-policies-agentpolicyid-outputs" }

package/lib/cjs/kibana/json/get_fleet_agent_status.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "policyId": { "type": "string", "description": "Filter by agent policy ID", "x-found-in": "query" }, "policyIds": { "type": "string", "description": "Filter by one or more agent policy IDs", "x-found-in": "query" }, "kuery": { "type": "string", "description": "A KQL query string to filter results", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-status" }

package/lib/cjs/kibana/json/get_fleet_agent_status_data.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentsIds": { "type": "string", "description": "Agent IDs to check data for, as an array or comma-separated string", "x-found-in": "query" }, "pkgName": { "type": "string", "description": "Filter by integration package name", "x-found-in": "query" }, "pkgVersion": { "type": "string", "description": "Filter by integration package version", "x-found-in": "query" }, "previewData": { "type": "boolean", "description": "When true, return a preview of the ingested data", "x-found-in": "query" } }, "required": ["agentsIds"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agent-status-data" }

package/lib/cjs/kibana/json/get_fleet_agents.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "page": { "type": "number", "description": "Page number", "x-found-in": "query" }, "perPage": { "type": "number", "description": "Number of results per page", "x-found-in": "query" }, "kuery": { "type": "string", "description": "A KQL query string to filter results", "x-found-in": "query" }, "showAgentless": { "type": "boolean", "description": "When true, include agentless agents in the results", "x-found-in": "query" }, "showInactive": { "type": "boolean", "description": "When true, include inactive agents in the results", "x-found-in": "query" }, "withMetrics": { "type": "boolean", "description": "When true, include CPU and memory metrics in the response", "x-found-in": "query" }, "showUpgradeable": { "type": "boolean", "description": "When true, only return agents that are upgradeable", "x-found-in": "query" }, "getStatusSummary": { "type": "boolean", "description": "When true, return a summary of agent statuses in the response", "x-found-in": "query" }, "sortField": { "type": "string", "description": "Field to sort results by", "x-found-in": "query" }, "sortOrder": { "type": "string", "description": "Sort order, ascending or descending", "x-found-in": "query" }, "searchAfter": { "type": "string", "description": "JSON-encoded array of sort values for `search_after` pagination", "x-found-in": "query" }, "openPit": { "type": "boolean", "description": "When true, opens a new point-in-time for pagination", "x-found-in": "query" }, "pitId": { "type": "string", "description": "Point-in-time ID for pagination", "x-found-in": "query" }, "pitKeepAlive": { "type": "string", "description": "Duration to keep the point-in-time alive, for example, `1m`", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agents" }

package/lib/cjs/kibana/json/get_fleet_agents_action_status.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "page": { "type": "number", "description": "Page number", "x-found-in": "query" }, "perPage": { "type": "number", "description": "Number of results per page", "x-found-in": "query" }, "date": { "type": "string", "description": "Return actions created before this date", "x-found-in": "query" }, "latest": { "type": "number", "description": "Return only the latest N actions", "x-found-in": "query" }, "errorSize": { "type": "number", "description": "Number of error details to include per action", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agents-action-status" }

package/lib/cjs/kibana/json/get_fleet_agents_agentid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentId": { "type": "string", "description": "The agent ID", "x-found-in": "path" }, "withMetrics": { "type": "boolean", "description": "When true, include CPU and memory metrics in the response", "x-found-in": "query" } }, "required": ["agentId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agents-agentid" }

package/lib/cjs/kibana/json/get_fleet_agents_agentid_effective_config.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentId": { "type": "string", "description": "The agent ID to get effective config of", "x-found-in": "path" } }, "required": ["agentId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agents-agentid-effective-config" }

package/lib/cjs/kibana/json/get_fleet_agents_agentid_uploads.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentId": { "type": "string", "description": "The agent ID", "x-found-in": "path" } }, "required": ["agentId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agents-agentid-uploads" }

package/lib/cjs/kibana/json/get_fleet_agents_files_fileid_filename.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "fileId": { "type": "string", "description": "The ID of the uploaded file", "x-found-in": "path" }, "fileName": { "type": "string", "description": "The name of the uploaded file", "x-found-in": "path" } }, "required": ["fileId", "fileName"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agents-files-fileid-filename" }

package/lib/cjs/kibana/json/get_fleet_agents_tags.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "kuery": { "type": "string", "description": "A KQL query string to filter results", "x-found-in": "query" }, "showInactive": { "type": "boolean", "description": "When true, include tags from inactive agents", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-agents-tags" }

package/lib/cjs/kibana/json/get_fleet_check_permissions.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "fleetServerSetup": { "type": "boolean", "description": "When true, check Fleet Server setup privileges in addition to standard Fleet privileges", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-check-permissions" }

package/lib/cjs/kibana/json/get_fleet_cloud_connectors.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "page": { "type": "string", "description": "The page number for pagination.", "x-found-in": "query" }, "perPage": { "type": "string", "description": "The number of items per page.", "x-found-in": "query" }, "kuery": { "type": "string", "description": "KQL query to filter cloud connectors.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-cloud-connectors" }

package/lib/cjs/kibana/json/get_fleet_cloud_connectors_cloudconnectorid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "cloudConnectorId": { "type": "string", "description": "The unique identifier of the cloud connector.", "x-found-in": "path" } }, "required": ["cloudConnectorId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-cloud-connectors-cloudconnectorid" }

package/lib/cjs/kibana/json/get_fleet_cloud_connectors_cloudconnectorid_usage.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "cloudConnectorId": { "type": "string", "description": "The unique identifier of the cloud connector.", "x-found-in": "path" }, "page": { "type": "number", "description": "The page number for pagination.", "x-found-in": "query" }, "perPage": { "type": "number", "description": "The number of items per page.", "x-found-in": "query" } }, "required": ["cloudConnectorId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-cloud-connectors-cloudconnectorid-usage" }

package/lib/cjs/kibana/json/get_fleet_enrollment_api_keys.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "page": { "type": "number", "description": "Page number", "x-found-in": "query" }, "perPage": { "type": "number", "description": "Number of results per page", "x-found-in": "query" }, "kuery": { "type": "string", "description": "A KQL query string to filter results", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-enrollment-api-keys" }

package/lib/cjs/kibana/json/get_fleet_enrollment_api_keys_keyid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "keyId": { "type": "string", "description": "The ID of the enrollment API key", "x-found-in": "path" } }, "required": ["keyId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-enrollment-api-keys-keyid" }

package/lib/cjs/kibana/json/get_fleet_epm_categories.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "prerelease": { "type": "boolean", "description": "When true, include prerelease packages in the results", "x-found-in": "query" }, "include_policy_templates": { "type": "boolean", "description": "When true, include categories that only contain policy templates", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-categories" }

package/lib/cjs/kibana/json/get_fleet_epm_data_streams.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "type": { "type": "string", "description": "Filter by data stream type", "x-found-in": "query" }, "datasetQuery": { "type": "string", "description": "Filter data streams by dataset name", "x-found-in": "query" }, "sortOrder": { "type": "string", "description": "Sort order, ascending or descending", "x-found-in": "query" }, "uncategorisedOnly": { "type": "boolean", "description": "When true, only return data streams that are not associated with a package", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-data-streams" }

package/lib/cjs/kibana/json/get_fleet_epm_packages.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "category": { "type": "string", "description": "Filter packages by category", "x-found-in": "query" }, "prerelease": { "type": "boolean", "description": "When true, include prerelease packages in the results", "x-found-in": "query" }, "excludeInstallStatus": { "type": "boolean", "description": "When true, exclude the install status from the response", "x-found-in": "query" }, "withPackagePoliciesCount": { "type": "boolean", "description": "When true, include the number of package policies per package", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_bulk_rollback_taskid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID of the bulk operation", "x-found-in": "path" } }, "required": ["taskId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-bulk-rollback-taskid" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_bulk_uninstall_taskid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID of the bulk operation", "x-found-in": "path" } }, "required": ["taskId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-bulk-uninstall-taskid" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_bulk_upgrade_taskid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID of the bulk operation", "x-found-in": "path" } }, "required": ["taskId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-bulk-upgrade-taskid" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_installed.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "dataStreamType": { "type": "string", "description": "Filter by data stream type", "x-found-in": "query" }, "showOnlyActiveDataStreams": { "type": "boolean", "description": "When true, only return packages with active data streams", "x-found-in": "query" }, "nameQuery": { "type": "string", "description": "Filter packages by name", "x-found-in": "query" }, "searchAfter": { "type": "string", "description": "Sort values from the previous page for `search_after` pagination", "x-found-in": "query" }, "perPage": { "type": "number", "description": "Number of results per page", "x-found-in": "query" }, "sortOrder": { "type": "string", "description": "Sort order, ascending or descending", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-installed" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_pkgname.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "pkgName": { "type": "string", "description": "Package name", "x-found-in": "path" }, "ignoreUnverified": { "type": "boolean", "description": "When true, returns the package even if the signature cannot be verified", "x-found-in": "query" }, "prerelease": { "type": "boolean", "description": "When true, include prerelease versions", "x-found-in": "query" }, "full": { "type": "boolean", "description": "When true, return the full package info including assets", "x-found-in": "query" }, "withMetadata": { "type": "boolean", "description": "When true, include package metadata such as whether it has package policies", "x-found-in": "query" } }, "required": ["pkgName"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-pkgname" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_pkgname_pkgversion.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "pkgName": { "type": "string", "description": "Package name", "x-found-in": "path" }, "pkgVersion": { "type": "string", "description": "Package version", "x-found-in": "path" }, "ignoreUnverified": { "type": "boolean", "description": "When true, returns the package even if the signature cannot be verified", "x-found-in": "query" }, "prerelease": { "type": "boolean", "description": "When true, include prerelease versions", "x-found-in": "query" }, "full": { "type": "boolean", "description": "When true, return the full package info including assets", "x-found-in": "query" }, "withMetadata": { "type": "boolean", "description": "When true, include package metadata such as whether it has package policies", "x-found-in": "query" } }, "required": ["pkgName", "pkgVersion"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-pkgname-pkgversion" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_pkgname_pkgversion_dependencies.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "pkgName": { "type": "string", "description": "Package name", "x-found-in": "path" }, "pkgVersion": { "type": "string", "description": "Package version", "x-found-in": "path" } }, "required": ["pkgName", "pkgVersion"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-pkgname-pkgversion-dependencies" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_pkgname_pkgversion_filepath.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "pkgName": { "type": "string", "description": "Package name", "x-found-in": "path" }, "pkgVersion": { "type": "string", "description": "Package version", "x-found-in": "path" }, "filePath": { "type": "string", "description": "File path within the package", "x-found-in": "path" } }, "required": ["pkgName", "pkgVersion", "filePath"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-pkgname-pkgversion-filepath" }

package/lib/cjs/kibana/json/get_fleet_epm_packages_pkgname_stats.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "pkgName": { "type": "string", "description": "Package name", "x-found-in": "path" } }, "required": ["pkgName"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-packages-pkgname-stats" }

package/lib/cjs/kibana/json/get_fleet_epm_templates_pkgname_pkgversion_inputs.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "pkgName": { "type": "string", "description": "Package name", "x-found-in": "path" }, "pkgVersion": { "type": "string", "description": "Package version", "x-found-in": "path" }, "format": { "type": "string", "description": "Output format for the inputs template: json, yml, or yaml", "x-found-in": "query" }, "prerelease": { "type": "boolean", "description": "When true, allow prerelease versions", "x-found-in": "query" }, "ignoreUnverified": { "type": "boolean", "description": "When true, return inputs even if the package signature cannot be verified", "x-found-in": "query" } }, "required": ["pkgName", "pkgVersion"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-epm-templates-pkgname-pkgversion-inputs" }

package/lib/cjs/kibana/json/get_fleet_fleet_server_hosts_itemid.request.json

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

package/lib/cjs/kibana/json/get_fleet_kubernetes.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "download": { "type": "boolean", "description": "If true, returns the manifest as a downloadable file", "x-found-in": "query" }, "fleetServer": { "type": "string", "description": "Fleet Server host URL to include in the manifest", "x-found-in": "query" }, "enrolToken": { "type": "string", "description": "Enrollment token to include in the manifest", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-kubernetes" }

package/lib/cjs/kibana/json/get_fleet_kubernetes_download.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "download": { "type": "boolean", "description": "If true, returns the manifest as a downloadable file", "x-found-in": "query" }, "fleetServer": { "type": "string", "description": "Fleet Server host URL to include in the manifest", "x-found-in": "query" }, "enrolToken": { "type": "string", "description": "Enrollment token to include in the manifest", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-kubernetes-download" }

package/lib/cjs/kibana/json/get_fleet_outputs_outputid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "outputId": { "type": "string", "description": "The ID of the output", "x-found-in": "path" } }, "required": ["outputId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-outputs-outputid" }

package/lib/cjs/kibana/json/get_fleet_outputs_outputid_health.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "outputId": { "type": "string", "description": "The ID of the output", "x-found-in": "path" } }, "required": ["outputId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-outputs-outputid-health" }

package/lib/cjs/kibana/json/get_fleet_package_policies.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "page": { "type": "number", "description": "Page number", "x-found-in": "query" }, "perPage": { "type": "number", "description": "Number of results per page", "x-found-in": "query" }, "sortField": { "type": "string", "description": "Field to sort results by", "x-found-in": "query" }, "sortOrder": { "type": "string", "description": "Sort order, ascending or descending", "x-found-in": "query" }, "showUpgradeable": { "type": "boolean", "description": "When true, only show policies with available upgrades", "x-found-in": "query" }, "kuery": { "type": "string", "description": "A KQL query string to filter results", "x-found-in": "query" }, "format": { "type": "string", "description": "Format for the response: simplified or legacy", "x-found-in": "query" }, "withAgentCount": { "type": "boolean", "description": "When true, include the agent count per package policy", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-package-policies" }

package/lib/cjs/kibana/json/get_fleet_package_policies_packagepolicyid.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "packagePolicyId": { "type": "string", "description": "The ID of the package policy", "x-found-in": "path" }, "format": { "type": "string", "description": "Format for the response: simplified or legacy", "x-found-in": "query" } }, "required": ["packagePolicyId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-package-policies-packagepolicyid" }

package/lib/cjs/kibana/json/get_fleet_proxies_itemid.request.json

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

package/lib/cjs/kibana/json/get_fleet_uninstall_tokens.request.json

@@ -0,0 +1 @@
+{ "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-fleet-uninstall-tokens" }

package/lib/cjs/kibana/json/get_fleet_uninstall_tokens_uninstalltokenid.request.json

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

package/lib/cjs/kibana/json/get_maintenance_window_find.request.json

@@ -0,0 +1 @@
+{ "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": "string", "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-maintenance-window-find" }

package/lib/cjs/kibana/json/get_maintenance_window_id.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the maintenance window.", "x-found-in": "path" } }, "required": ["id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-maintenance-window-id" }

package/lib/cjs/kibana/json/get_notes.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "documentIds": { "type": "string", "description": "Event document `_id` values to match against each note's `eventId`. When this parameter is present, the response is all matching notes (up to the server's hard limit), not a paged list using `page`/`perPage`.", "x-found-in": "query" }, "savedObjectIds": { "type": "string", "description": "Timeline `savedObjectId` value(s). Returns notes that reference those timelines. When present, list-mode pagination parameters are not used; up to the server's hard limit of notes may be returned.", "x-found-in": "query" }, "page": { "type": "string", "description": "Page number for list mode (when `documentIds` and `savedObjectIds` are omitted). Passed as a string; default 1.", "x-found-in": "query" }, "perPage": { "type": "string", "description": "Page size for list mode (when `documentIds` and `savedObjectIds` are omitted). Passed as a string; default 10.", "x-found-in": "query" }, "search": { "type": "string", "description": "Search string for saved-objects find (list mode only).", "x-found-in": "query" }, "sortField": { "type": "string", "description": "Field to sort by for saved-objects find (list mode only).", "x-found-in": "query" }, "sortOrder": { "type": "string", "description": "Sort order (`asc` or `desc`) for saved-objects find (list mode only).", "x-found-in": "query" }, "filter": { "type": "string", "description": "Kuery filter string combined with other list-mode filters (for example `createdByFilter` or `associatedFilter`). Typed as a string for API compatibility; interpreted by the saved-objects layer (list mode only).", "x-found-in": "query" }, "createdByFilter": { "type": "string", "description": "Kibana user profile **UID** (UUID). The server resolves the user's display identifiers and returns notes whose `createdBy` matches any of them (list mode only).", "x-found-in": "query" }, "associatedFilter": { "type": "string", "description": "Restricts notes by how they relate to a Timeline and/or an event document (list mode only). Some values apply extra filtering after the query. Ignored when `documentIds` or `savedObjectIds` is used.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetNotes" }

package/lib/cjs/kibana/json/get_policy_response.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "agentId": { "type": "string", "description": "The agent ID to retrieve the policy response for.", "x-found-in": "query" } }, "required": ["agentId"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetPolicyResponse" }

package/lib/cjs/kibana/json/get_protection_updates_note.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "package_policy_id": { "type": "string", "description": "The package policy ID to retrieve the protection updates note for.", "x-found-in": "path" } }, "required": ["package_policy_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetProtectionUpdatesNote" }

package/lib/cjs/kibana/json/get_risk_score_history.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "entity_type": { "type": "string", "description": "The type of entity to retrieve history for.", "x-found-in": "query" }, "entity_id": { "type": "string", "description": "The identifier of the entity to retrieve history for.", "x-found-in": "query" }, "from": { "type": "string", "description": "Start of the time range, in date-math syntax. Defaults to 90 days ago.", "x-found-in": "query" }, "to": { "type": "string", "description": "End of the time range, in date-math syntax. Defaults to now.", "x-found-in": "query" }, "score_type": { "type": "string", "description": "Filter entries by the type of score recorded (`base`, `propagated`, or `resolution`).", "x-found-in": "query" }, "page_size": { "type": "number", "description": "Maximum number of history entries to return per request.", "x-found-in": "query" } }, "required": ["entity_type", "entity_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "GetRiskScoreHistory" }

package/lib/cjs/kibana/json/get_runtime_field_default.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "viewId": { "type": "string", "description": "The viewId parameter", "x-found-in": "path" }, "fieldName": { "type": "string", "description": "The fieldName parameter", "x-found-in": "path" } }, "required": ["viewId", "fieldName"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getRuntimeFieldDefault" }

package/lib/cjs/kibana/json/get_security_entity_store_entities.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "filter": { "type": "string", "description": "A Kibana Query Language (KQL) filter for the search-after mode.", "x-found-in": "query" }, "size": { "type": "number", "description": "Number of entities to return in search-after mode.", "x-found-in": "query" }, "searchAfter": { "type": "string", "description": "JSON-encoded search_after value for cursor-based pagination.", "x-found-in": "query" }, "source": { "type": "string", "description": "Fields to include in the response source.", "x-found-in": "query" }, "fields": { "type": "string", "description": "Fields to include in the response.", "x-found-in": "query" }, "sort_field": { "type": "string", "description": "Field to sort results by in page mode.", "x-found-in": "query" }, "sort_order": { "type": "string", "description": "Sort order in page mode.", "x-found-in": "query" }, "page": { "type": "number", "description": "Page number to return (1-indexed) in page mode.", "x-found-in": "query" }, "per_page": { "type": "number", "description": "Number of entities per page in page mode.", "x-found-in": "query" }, "filterQuery": { "type": "string", "description": "An Elasticsearch query string to filter entities in page mode.", "x-found-in": "query" }, "entity_types": { "type": "string", "description": "Entity types to include in the results.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-security-entity-store-entities" }

package/lib/cjs/kibana/json/get_security_entity_store_resolution_group.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "entity_id": { "type": "string", "description": "The entity identifier to look up the resolution group for.", "x-found-in": "query" } }, "required": ["entity_id"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-security-entity-store-resolution-group" }

package/lib/cjs/kibana/json/get_security_entity_store_status.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "include_components": { "type": "string", "description": "If true, returns a detailed status of each engine including all its components.", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-security-entity-store-status" }

package/lib/cjs/kibana/json/get_security_role.request.json

@@ -0,0 +1 @@
+{ "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" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-security-role" }

package/lib/cjs/kibana/json/get_security_role_name.request.json

@@ -0,0 +1 @@
+{ "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"], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-security-role-name" }

package/lib/cjs/kibana/json/get_single_agent_configuration.request.json

@@ -0,0 +1 @@
+{ "type": "object", "properties": { "name": { "type": "string", "description": "Service name", "x-found-in": "query" }, "environment": { "type": "string", "description": "Service environment", "x-found-in": "query" } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getSingleAgentConfiguration" }