@elastic/schemas 0.6.0 → 0.6.2

package/src/kibana/json/find_conversations.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_AI_Assistant_API_ConversationResponse"},"description":"A list of conversations."},"page":{"type":"number","description":"The current page of the results."},"perPage":{"type":"number","description":"The number of results returned per page."},"total":{"type":"number","description":"The total number of conversations matching the filter criteria."}},"required":["page","perPage","total","data"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindConversations"}

package/src/kibana/json/find_endpoint_list_items.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_endpoint_list_items.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItem"},"description":"The list of endpoint exception list items."},"page":{"type":"number","description":"The current page number."},"per_page":{"type":"number","description":"The number of items per page."},"pit":{"type":"string","description":"The point-in-time ID for pagination."},"total":{"type":"number","description":"The total number of endpoint exception list items."}},"required":["data","page","per_page","total"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindEndpointListItems"}

package/src/kibana/json/find_exception_list_items.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_exception_list_items.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Exceptions_API_ExceptionListItem"}},"page":{"type":"number"},"per_page":{"type":"number"},"pit":{"type":"string"},"total":{"type":"number"}},"required":["data","page","per_page","total"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindExceptionListItems"}

package/src/kibana/json/find_exception_lists.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_exception_lists.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Exceptions_API_ExceptionList"}},"page":{"type":"number"},"per_page":{"type":"number"},"total":{"type":"number"}},"required":["data","page","per_page","total"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindExceptionLists"}

package/src/kibana/json/find_knowledge_base_entries.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_knowledge_base_entries.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_AI_Assistant_API_KnowledgeBaseEntryResponse"},"description":"The list of Knowledge Base Entries for the current page."},"page":{"type":"number","description":"The current page number."},"perPage":{"type":"number","description":"The number of Knowledge Base Entries returned per page."},"total":{"type":"number","description":"The total number of Knowledge Base Entries available."}},"required":["page","perPage","total","data"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindKnowledgeBaseEntries"}

package/src/kibana/json/find_list_items.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_list_items.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"cursor":{"$ref":"./_defs.json#/$defs/Security_Lists_API_FindListItemsCursor"},"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Lists_API_ListItem"}},"page":{"type":"number"},"per_page":{"type":"number"},"total":{"type":"number"}},"required":["data","page","per_page","total","cursor"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindListItems"}

package/src/kibana/json/find_lists.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_lists.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"cursor":{"$ref":"./_defs.json#/$defs/Security_Lists_API_FindListsCursor"},"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Lists_API_List"}},"page":{"type":"number"},"per_page":{"type":"number"},"total":{"type":"number"}},"required":["data","page","per_page","total","cursor"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindLists"}

package/src/kibana/json/find_prompts.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_prompts.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_AI_Assistant_API_PromptResponse"},"description":"The list of prompts returned based on the search query, sorting, and pagination."},"page":{"type":"number","description":"Current page number."},"perPage":{"type":"number","description":"Number of prompts per page."},"total":{"type":"number","description":"Total number of prompts matching the query."}},"required":["page","perPage","total","data"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindPrompts"}

package/src/kibana/json/find_rules.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_rules.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Detections_API_RuleResponse"}},"page":{"type":"number"},"perPage":{"type":"number"},"total":{"type":"number"},"warnings":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Detections_API_WarningSchema"}}},"required":["page","perPage","total","data"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"FindRules"}

package/src/kibana/json/find_slos_op.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/find_slos_op.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/SLOs_find_slo_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"findSlosOp"}

package/src/kibana/json/get_actions_connector_id.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_actions_connector_id.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_connector_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-actions-connector-id"}

package/src/kibana/json/get_actions_connector_oauth_callback.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_actions_connector_types.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_actions_connector_types.response.json

@@ -1 +0,0 @@
-{"type":"array","items":{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_connector_type_response"},"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-actions-connector-types"}

package/src/kibana/json/get_actions_connectors.response.json

@@ -1 +0,0 @@
-{"type":"array","items":{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_connector_response_with_references_count"},"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-actions-connectors"}

package/src/kibana/json/get_agent_builder_a2a_agentid.json.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_agents_id.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_agents_id_acl.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_conversations.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_conversations_conversation_id.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_conversations_conversation_id_attachments.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_conversations_conversation_id_attachments_stale.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_plugins_pluginid.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_skills.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_skills_skillid.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_builder_tools_toolid.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_configurations.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/APM_UI_agent_configurations_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"getAgentConfigurations"}

package/src/kibana/json/get_agent_name_for_service.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_agent_name_for_service.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/APM_UI_service_agent_name_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"getAgentNameForService"}

package/src/kibana/json/get_alerting_rule_id.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_alerting_rule_id.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_rule_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-alerting-rule-id"}

package/src/kibana/json/get_alerting_rule_id_query_inspector.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_alerting_rule_id_query_inspector.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"queries":{"type":"array","items":{"type":"object","properties":{"index":{"type":"string"},"label":{"type":"string"},"request":{"type":"object","additionalProperties":{}},"response":{"type":"object","additionalProperties":{}}},"required":["index","request"]}}},"required":["queries"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-alerting-rule-id-query-inspector"}

package/src/kibana/json/get_alerting_rules_backfill_id.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_alerting_rules_backfill_id.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_backfill_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-alerting-rules-backfill-id"}

package/src/kibana/json/get_alerting_rules_find.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_alerting_rules_find.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_rule_response"}},"page":{"type":"number"},"per_page":{"type":"number"},"total":{"type":"number"}},"required":["page","per_page","total","data"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-alerting-rules-find"}

package/src/kibana/json/get_all_data_views_default.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data_view":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"typeMeta":{"type":"object"}}}}},"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getAllDataViewsDefault"}

package/src/kibana/json/get_annotation.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_annotation.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/APM_UI_annotation_search_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"getAnnotation"}

package/src/kibana/json/get_asset_criticality_record.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_asset_criticality_record.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Security_Entity_Analytics_API_AssetCriticalityRecord","$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetAssetCriticalityRecord"}

package/src/kibana/json/get_attack_discovery_generation.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_attack_discovery_generation.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Attack_discovery_API_AttackDiscoveryApiAlert"},"description":"Array of Attack discoveries generated during this execution."},"generation":{"$ref":"./_defs.json#/$defs/Security_Attack_discovery_API_AttackDiscoveryGeneration","description":"Optional metadata about the attack discovery generation process, metadata including execution status and statistics. This metadata may not be available for all generations."}},"required":["data"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetAttackDiscoveryGeneration"}

package/src/kibana/json/get_attack_discovery_generations.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_attack_discovery_generations.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"generations":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Attack_discovery_API_AttackDiscoveryGeneration"},"description":"List of Attack Discovery generations"}},"required":["generations"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetAttackDiscoveryGenerations"}

package/src/kibana/json/get_attack_discovery_schedules.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_attack_discovery_schedules.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Security_Attack_discovery_API_AttackDiscoveryApiSchedule","$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetAttackDiscoverySchedules"}

package/src/kibana/json/get_dashboard_redirect.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_data_view_default.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_data_view_default.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Data_views_data_view_response_object","$schema":"https://json-schema.org/draft/2020-12/schema","title":"getDataViewDefault"}

package/src/kibana/json/get_default_data_view_default.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"data_view_id":{"type":"string"}},"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getDefaultDataViewDefault"}

package/src/kibana/json/get_definitions_op.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_definitions_op.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/SLOs_find_slo_definitions_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"getDefinitionsOp"}

package/src/kibana/json/get_draft_timelines.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_draft_timelines.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Security_Timeline_API_TimelineResponse","$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetDraftTimelines"}

package/src/kibana/json/get_endpoint_metadata.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_endpoint_metadata.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Security_Endpoint_Management_API_EndpointMetadataResponse","$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetEndpointMetadata"}

package/src/kibana/json/get_endpoint_metadata_list.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_endpoint_metadata_list.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Security_Endpoint_Management_API_MetadataListResponse","$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetEndpointMetadataList"}

package/src/kibana/json/get_entity_engine.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_entity_engine.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Security_Entity_Analytics_API_EngineDescriptor","$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetEntityEngine"}

package/src/kibana/json/get_entity_store_status.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_entity_store_status.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"engines":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"components":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Security_Entity_Analytics_API_EngineComponentStatus"},"description":"Detailed component-level status. Only included when include_components is true."}}},{"$ref":"./_defs.json#/$defs/Security_Entity_Analytics_API_EngineDescriptor"}]},"description":"Per-engine status information."},"status":{"$ref":"./_defs.json#/$defs/Security_Entity_Analytics_API_StoreStatus","description":"The overall status of the Entity Store."}},"required":["status","engines"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"GetEntityStoreStatus"}

package/src/kibana/json/get_environments_for_service.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_environments_for_service.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/APM_UI_service_environments_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"getEnvironmentsForService"}

package/src/kibana/json/get_fleet_agent_download_sources.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"auth":{"oneOf":[{"type":"object","properties":{"api_key":{"type":"string"},"headers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]}},"password":{"type":"string"},"username":{"type":"string"}}},{"type":"null"}]},"host":{"type":"string"},"id":{"type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"},"proxy_id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the proxy to use for this download source. See the proxies API for more information."},"secrets":{"type":"object","properties":{"auth":{"type":"object","properties":{"api_key":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"string"}]},"password":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"string"}]}}},"ssl":{"type":"object","properties":{"key":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"string"}]}}}}},"ssl":{"type":"object","properties":{"certificate":{"type":"string"},"certificate_authorities":{"type":"array","items":{"type":"string"}},"key":{"type":"string"}}}},"required":["id","name","host"]}},"page":{"type":"number"},"perPage":{"type":"number"},"total":{"type":"number"}},"required":["items","total","page","perPage"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-download-sources"}

package/src/kibana/json/get_fleet_agent_download_sources_sourceid.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_download_sources_sourceid.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"item":{"type":"object","properties":{"auth":{"oneOf":[{"type":"object","properties":{"api_key":{"type":"string"},"headers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]}},"password":{"type":"string"},"username":{"type":"string"}}},{"type":"null"}]},"host":{"type":"string"},"id":{"type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"},"proxy_id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the proxy to use for this download source. See the proxies API for more information."},"secrets":{"type":"object","properties":{"auth":{"type":"object","properties":{"api_key":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"string"}]},"password":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"string"}]}}},"ssl":{"type":"object","properties":{"key":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"string"}]}}}}},"ssl":{"type":"object","properties":{"certificate":{"type":"string"},"certificate_authorities":{"type":"array","items":{"type":"string"}},"key":{"type":"string"}}}},"required":["id","name","host"]}},"required":["item"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-download-sources-sourceid"}

package/src/kibana/json/get_fleet_agent_policies.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_policies.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_agent_policy_response"}},"page":{"type":"number"},"perPage":{"type":"number"},"total":{"type":"number"}},"required":["items","total","page","perPage"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-policies"}

package/src/kibana/json/get_fleet_agent_policies_agentpolicyid.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_policies_agentpolicyid.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_get_agent_policy_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-policies-agentpolicyid"}

package/src/kibana/json/get_fleet_agent_policies_agentpolicyid_auto_upgrade_agents_status.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_policies_agentpolicyid_auto_upgrade_agents_status.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"currentVersions":{"type":"array","items":{"type":"object","properties":{"agents":{"type":"number","description":"Number of agents that upgraded to this version"},"failedUpgradeActionIds":{"type":"array","items":{"type":"string"},"description":"List of action IDs related to failed upgrades"},"failedUpgradeAgents":{"type":"number","description":"Number of agents that failed to upgrade to this version"},"inProgressUpgradeActionIds":{"type":"array","items":{"type":"string"},"description":"List of action IDs related to in-progress upgrades"},"inProgressUpgradeAgents":{"type":"number","description":"Number of agents that are upgrading to this version"},"version":{"type":"string","description":"Agent version"}},"required":["version","agents","failedUpgradeAgents","inProgressUpgradeAgents"]}},"totalAgents":{"type":"number"}},"required":["currentVersions","totalAgents"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-policies-agentpolicyid-auto-upgrade-agents-status"}

package/src/kibana/json/get_fleet_agent_policies_agentpolicyid_download.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_policies_agentpolicyid_download.response.json

@@ -1 +0,0 @@
-{"type":"string","$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-policies-agentpolicyid-download"}

package/src/kibana/json/get_fleet_agent_policies_agentpolicyid_full.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_policies_agentpolicyid_full.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_get_full_agent_policy_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-policies-agentpolicyid-full"}

package/src/kibana/json/get_fleet_agent_policies_agentpolicyid_outputs.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_policies_agentpolicyid_outputs.response.json

@@ -1 +0,0 @@
-{"$ref":"./_defs.json#/$defs/Kibana_HTTP_APIs_get_agent_policy_outputs_response","$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-policies-agentpolicyid-outputs"}

package/src/kibana/json/get_fleet_agent_status.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_status.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"results":{"type":"object","properties":{"active":{"type":"number"},"all":{"type":"number"},"error":{"type":"number"},"events":{"type":"number"},"inactive":{"type":"number"},"offline":{"type":"number"},"online":{"type":"number"},"orphaned":{"type":"number"},"other":{"type":"number"},"unenrolled":{"type":"number"},"uninstalled":{"type":"number"},"updating":{"type":"number"}},"required":["events","online","error","offline","other","updating","inactive","unenrolled","all","active"]}},"required":["results"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-status"}

package/src/kibana/json/get_fleet_agent_status_data.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agent_status_data.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"dataPreview":{"type":"array","items":{}},"items":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","properties":{"data":{"type":"boolean"}},"required":["data"]}}}},"required":["items","dataPreview"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agent-status-data"}

package/src/kibana/json/get_fleet_agents.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agents.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"access_api_key":{"type":"string"},"access_api_key_id":{"type":"string"},"active":{"type":"boolean"},"agent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"required":["id","version"],"additionalProperties":true},"audit_unenrolled_reason":{"type":"string"},"capabilities":{"type":"array","items":{"type":"string"}},"components":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"},"status":{"enum":["STARTING","CONFIGURING","HEALTHY","DEGRADED","FAILED","STOPPING","STOPPED"]},"type":{"type":"string"},"units":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"},"payload":{"type":"object","additionalProperties":{}},"status":{"enum":["STARTING","CONFIGURING","HEALTHY","DEGRADED","FAILED","STOPPING","STOPPED"]},"type":{"enum":["input","output",""]}},"required":["id","type","status","message"]}}},"required":["id","type","status","message"]}},"default_api_key":{"type":"string"},"default_api_key_history":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"retired_at":{"type":"string"}},"required":["id","retired_at"]}},"default_api_key_id":{"type":"string"},"effective_config":{},"enrolled_at":{"type":"string"},"health":{"type":"object","additionalProperties":{}},"id":{"type":"string"},"identifying_attributes":{"type":"object","additionalProperties":{"type":"string"}},"last_checkin":{"type":"string"},"last_checkin_message":{"type":"string"},"last_checkin_status":{"enum":["error","online","degraded","updating","starting","disconnected"]},"last_known_status":{"enum":["offline","error","online","inactive","enrolling","unenrolling","unenrolled","updating","degraded","uninstalled","orphaned"]},"local_metadata":{"type":"object","additionalProperties":{}},"metrics":{"type":"object","properties":{"cpu_avg":{"type":"number"},"memory_size_byte_avg":{"type":"number"}}},"namespaces":{"type":"array","items":{"type":"string"}},"non_identifying_attributes":{"type":"object","additionalProperties":{"type":"string"}},"outputs":{"type":"object","additionalProperties":{"type":"object","properties":{"api_key_id":{"type":"string"},"to_retire_api_key_ids":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"retired_at":{"type":"string"}},"required":["id","retired_at"]}},"type":{"type":"string"}}}},"packages":{"type":"array","items":{"type":"string"}},"pipeline_config":{"type":"string"},"policy_id":{"type":"string"},"policy_revision":{"oneOf":[{"type":"number"},{"type":"null"}]},"sequence_num":{"type":"number"},"signals":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{}},"status":{"enum":["offline","error","online","inactive","enrolling","unenrolling","unenrolled","updating","degraded","uninstalled","orphaned"]},"tags":{"type":"array","items":{"type":"string"}},"type":{"enum":["PERMANENT","EPHEMERAL","TEMPORARY","OPAMP"]},"unenrolled_at":{"type":"string"},"unenrollment_started_at":{"type":"string"},"unhealthy_reason":{"oneOf":[{"type":"array","items":{"enum":["input","output","other"]}},{"type":"null"}]},"upgrade":{"type":"object","properties":{"rollbacks":{"type":"array","items":{"type":"object","properties":{"valid_until":{"type":"string"},"version":{"type":"string"}},"required":["valid_until","version"]}}}},"upgrade_attempts":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"upgrade_details":{"oneOf":[{"type":"object","properties":{"action_id":{"type":"string"},"metadata":{"type":"object","properties":{"download_percent":{"type":"number"},"download_rate":{"type":"number"},"error_msg":{"type":"string"},"failed_state":{"enum":["UPG_REQUESTED","UPG_SCHEDULED","UPG_DOWNLOADING","UPG_EXTRACTING","UPG_REPLACING","UPG_RESTARTING","UPG_FAILED","UPG_WATCHING","UPG_ROLLBACK"]},"reason":{"type":"string"},"retry_error_msg":{"type":"string"},"retry_until":{"type":"string"},"scheduled_at":{"type":"string"}}},"state":{"enum":["UPG_REQUESTED","UPG_SCHEDULED","UPG_DOWNLOADING","UPG_EXTRACTING","UPG_REPLACING","UPG_RESTARTING","UPG_FAILED","UPG_WATCHING","UPG_ROLLBACK"]},"target_version":{"type":"string"}},"required":["target_version","action_id","state"]},{"type":"null"}]},"upgrade_started_at":{"oneOf":[{"type":"string"},{"type":"null"}]},"upgraded_at":{"oneOf":[{"type":"string"},{"type":"null"}]},"user_provided_metadata":{"type":"object","additionalProperties":{}}},"required":["id","packages","type","active","enrolled_at","local_metadata","effective_config"]}},"nextSearchAfter":{"type":"string"},"page":{"type":"number"},"perPage":{"type":"number"},"pit":{"type":"string"},"statusSummary":{"type":"object","additionalProperties":{"type":"number"}},"total":{"type":"number"}},"required":["items","total","page","perPage"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agents"}

package/src/kibana/json/get_fleet_agents_action_status.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agents_action_status.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"actionId":{"type":"string"},"cancellationTime":{"type":"string"},"completionTime":{"type":"string"},"creationTime":{"type":"string","description":"creation time of action"},"expiration":{"type":"string"},"hasRolloutPeriod":{"type":"boolean"},"is_automatic":{"type":"boolean"},"latestErrors":{"type":"array","items":{"type":"object","properties":{"agentId":{"type":"string"},"error":{"type":"string"},"hostname":{"type":"string"},"timestamp":{"type":"string"}},"required":["agentId","error","timestamp"]}},"nbAgentsAck":{"type":"number","description":"number of agents that acknowledged the action"},"nbAgentsActionCreated":{"type":"number","description":"number of agents included in action from kibana"},"nbAgentsActioned":{"type":"number","description":"number of agents actioned"},"nbAgentsFailed":{"type":"number","description":"number of agents that failed to execute the action"},"newPolicyId":{"type":"string","description":"new policy id (POLICY_REASSIGN action)"},"policyId":{"type":"string","description":"policy id (POLICY_CHANGE action)"},"revision":{"type":"number","description":"new policy revision (POLICY_CHANGE action)"},"startTime":{"type":"string","description":"start time of action (scheduled actions)"},"status":{"enum":["COMPLETE","EXPIRED","CANCELLED","FAILED","IN_PROGRESS","ROLLOUT_PASSED"]},"type":{"enum":["UPGRADE","UNENROLL","SETTINGS","POLICY_REASSIGN","CANCEL","FORCE_UNENROLL","REQUEST_DIAGNOSTICS","UPDATE_TAGS","POLICY_CHANGE","INPUT_ACTION","MIGRATE","PRIVILEGE_LEVEL_CHANGE","ROLLBACK"]},"version":{"type":"string","description":"agent version number (UPGRADE action)"}},"required":["actionId","nbAgentsActionCreated","nbAgentsAck","nbAgentsFailed","type","nbAgentsActioned","status","creationTime"]}}},"required":["items"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agents-action-status"}

package/src/kibana/json/get_fleet_agents_agentid.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agents_agentid.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"item":{"type":"object","properties":{"access_api_key":{"type":"string"},"access_api_key_id":{"type":"string"},"active":{"type":"boolean"},"agent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"required":["id","version"],"additionalProperties":true},"audit_unenrolled_reason":{"type":"string"},"capabilities":{"type":"array","items":{"type":"string"}},"components":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"},"status":{"enum":["STARTING","CONFIGURING","HEALTHY","DEGRADED","FAILED","STOPPING","STOPPED"]},"type":{"type":"string"},"units":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"},"payload":{"type":"object","additionalProperties":{}},"status":{"enum":["STARTING","CONFIGURING","HEALTHY","DEGRADED","FAILED","STOPPING","STOPPED"]},"type":{"enum":["input","output",""]}},"required":["id","type","status","message"]}}},"required":["id","type","status","message"]}},"default_api_key":{"type":"string"},"default_api_key_history":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"retired_at":{"type":"string"}},"required":["id","retired_at"]}},"default_api_key_id":{"type":"string"},"effective_config":{},"enrolled_at":{"type":"string"},"health":{"type":"object","additionalProperties":{}},"id":{"type":"string"},"identifying_attributes":{"type":"object","additionalProperties":{"type":"string"}},"last_checkin":{"type":"string"},"last_checkin_message":{"type":"string"},"last_checkin_status":{"enum":["error","online","degraded","updating","starting","disconnected"]},"last_known_status":{"enum":["offline","error","online","inactive","enrolling","unenrolling","unenrolled","updating","degraded","uninstalled","orphaned"]},"local_metadata":{"type":"object","additionalProperties":{}},"metrics":{"type":"object","properties":{"cpu_avg":{"type":"number"},"memory_size_byte_avg":{"type":"number"}}},"namespaces":{"type":"array","items":{"type":"string"}},"non_identifying_attributes":{"type":"object","additionalProperties":{"type":"string"}},"outputs":{"type":"object","additionalProperties":{"type":"object","properties":{"api_key_id":{"type":"string"},"to_retire_api_key_ids":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"retired_at":{"type":"string"}},"required":["id","retired_at"]}},"type":{"type":"string"}}}},"packages":{"type":"array","items":{"type":"string"}},"pipeline_config":{"type":"string"},"policy_id":{"type":"string"},"policy_revision":{"oneOf":[{"type":"number"},{"type":"null"}]},"sequence_num":{"type":"number"},"signals":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{}},"status":{"enum":["offline","error","online","inactive","enrolling","unenrolling","unenrolled","updating","degraded","uninstalled","orphaned"]},"tags":{"type":"array","items":{"type":"string"}},"type":{"enum":["PERMANENT","EPHEMERAL","TEMPORARY","OPAMP"]},"unenrolled_at":{"type":"string"},"unenrollment_started_at":{"type":"string"},"unhealthy_reason":{"oneOf":[{"type":"array","items":{"enum":["input","output","other"]}},{"type":"null"}]},"upgrade":{"type":"object","properties":{"rollbacks":{"type":"array","items":{"type":"object","properties":{"valid_until":{"type":"string"},"version":{"type":"string"}},"required":["valid_until","version"]}}}},"upgrade_attempts":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"upgrade_details":{"oneOf":[{"type":"object","properties":{"action_id":{"type":"string"},"metadata":{"type":"object","properties":{"download_percent":{"type":"number"},"download_rate":{"type":"number"},"error_msg":{"type":"string"},"failed_state":{"enum":["UPG_REQUESTED","UPG_SCHEDULED","UPG_DOWNLOADING","UPG_EXTRACTING","UPG_REPLACING","UPG_RESTARTING","UPG_FAILED","UPG_WATCHING","UPG_ROLLBACK"]},"reason":{"type":"string"},"retry_error_msg":{"type":"string"},"retry_until":{"type":"string"},"scheduled_at":{"type":"string"}}},"state":{"enum":["UPG_REQUESTED","UPG_SCHEDULED","UPG_DOWNLOADING","UPG_EXTRACTING","UPG_REPLACING","UPG_RESTARTING","UPG_FAILED","UPG_WATCHING","UPG_ROLLBACK"]},"target_version":{"type":"string"}},"required":["target_version","action_id","state"]},{"type":"null"}]},"upgrade_started_at":{"oneOf":[{"type":"string"},{"type":"null"}]},"upgraded_at":{"oneOf":[{"type":"string"},{"type":"null"}]},"user_provided_metadata":{"type":"object","additionalProperties":{}}},"required":["id","packages","type","active","enrolled_at","local_metadata","effective_config"]}},"required":["item"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agents-agentid"}

package/src/kibana/json/get_fleet_agents_agentid_effective_config.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agents_agentid_effective_config.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"effective_config":{}},"required":["effective_config"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agents-agentid-effective-config"}

package/src/kibana/json/get_fleet_agents_agentid_uploads.request.json

@@ -1 +0,0 @@
-{"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/src/kibana/json/get_fleet_agents_agentid_uploads.response.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"actionId":{"type":"string"},"createTime":{"type":"string"},"error":{"type":"string"},"filePath":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"status":{"enum":["READY","AWAITING_UPLOAD","DELETED","EXPIRED","IN_PROGRESS","FAILED"]}},"required":["id","name","filePath","createTime","status","actionId"]}}},"required":["items"],"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-fleet-agents-agentid-uploads"}