@elastic/schemas 0.6.0 → 0.6.2

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "RulePreview", "x-api": { "id": "security-detections-api.rule-preview", "name": "rule-preview", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/rules/preview", "x-destructive": true, "type": "object", "properties": { "enable_logged_requests": { "type": "boolean", "description": "Enables logging and returning in response ES queries, performed during rule execution", "x-found-in": "query" }, "actions": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleAction" }, "description": "Array defining the automated actions (notifications) taken when alerts are generated.", "x-found-in": "body" }, "alias_purpose": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SavedObjectResolveAliasPurpose", "x-found-in": "body" }, "alias_target_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SavedObjectResolveAliasTargetId", "x-found-in": "body" }, "author": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleAuthorArray", "x-found-in": "body" }, "building_block_type": { "$ref": "./_defs.json#/$defs/Security_Detections_API_BuildingBlockType", "x-found-in": "body" }, "description": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleDescription", "x-found-in": "body" }, "enabled": { "$ref": "./_defs.json#/$defs/Security_Detections_API_IsRuleEnabled", "x-found-in": "body" }, "exceptions_list": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleExceptionList" }, "x-found-in": "body" }, "false_positives": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleFalsePositiveArray", "x-found-in": "body" }, "from": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleIntervalFrom", "x-found-in": "body" }, "interval": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleInterval", "x-found-in": "body" }, "investigation_fields": { "$ref": "./_defs.json#/$defs/Security_Detections_API_InvestigationFields", "x-found-in": "body" }, "license": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleLicense", "x-found-in": "body" }, "max_signals": { "$ref": "./_defs.json#/$defs/Security_Detections_API_MaxSignals", "x-found-in": "body" }, "meta": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleMetadata", "x-found-in": "body" }, "name": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleName", "x-found-in": "body" }, "namespace": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AlertsIndexNamespace", "x-found-in": "body" }, "note": { "$ref": "./_defs.json#/$defs/Security_Detections_API_InvestigationGuide", "x-found-in": "body" }, "outcome": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SavedObjectResolveOutcome", "x-found-in": "body" }, "output_index": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AlertsIndex", "x-found-in": "body" }, "references": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleReferenceArray", "x-found-in": "body" }, "related_integrations": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RelatedIntegrationArray", "x-found-in": "body" }, "required_fields": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RequiredFieldInput" }, "description": "Elasticsearch fields and their types that need to be present for the rule to function.\n> info\n> The value of `required_fields` does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Use `required_fields` as an informational property to document the fields that the rule expects to be present in the data.\n", "x-found-in": "body" }, "response_actions": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ResponseAction" }, "x-found-in": "body" }, "risk_score": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RiskScore", "x-found-in": "body" }, "risk_score_mapping": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RiskScoreMapping", "x-found-in": "body" }, "rule_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleSignatureId", "x-found-in": "body" }, "rule_name_override": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleNameOverride", "x-found-in": "body" }, "setup": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SetupGuide", "x-found-in": "body" }, "severity": { "$ref": "./_defs.json#/$defs/Security_Detections_API_Severity", "x-found-in": "body" }, "severity_mapping": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SeverityMapping", "x-found-in": "body" }, "tags": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleTagArray", "x-found-in": "body" }, "threat": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatArray", "x-found-in": "body" }, "throttle": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleActionThrottle", "x-found-in": "body" }, "timeline_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimelineTemplateId", "x-found-in": "body" }, "timeline_title": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimelineTemplateTitle", "x-found-in": "body" }, "timestamp_override": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimestampOverride", "x-found-in": "body" }, "timestamp_override_fallback_disabled": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimestampOverrideFallbackDisabled", "x-found-in": "body" }, "to": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleIntervalTo", "x-found-in": "body" }, "version": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleVersion", "x-found-in": "body" }, "language": { "$ref": "./_defs.json#/$defs/Security_Detections_API_EsqlQueryLanguage", "x-found-in": "body" }, "query": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleQuery", "x-found-in": "body" }, "type": { "enum": ["esql"], "description": "Rule type", "x-found-in": "body" }, "alert_suppression": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AlertSuppression", "x-found-in": "body" }, "data_view_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_DataViewId", "x-found-in": "body" }, "event_category_override": { "$ref": "./_defs.json#/$defs/Security_Detections_API_EventCategoryOverride", "x-found-in": "body" }, "filters": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleFilterArray", "x-found-in": "body" }, "index": { "$ref": "./_defs.json#/$defs/Security_Detections_API_IndexPatternArray", "x-found-in": "body" }, "tiebreaker_field": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TiebreakerField", "x-found-in": "body" }, "timestamp_field": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimestampField", "x-found-in": "body" }, "invocationCount": { "type": "number", "x-found-in": "body" }, "timeframeEnd": { "type": "string", "x-found-in": "body" }, "saved_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SavedQueryId", "x-found-in": "body" }, "threshold": { "$ref": "./_defs.json#/$defs/Security_Detections_API_Threshold", "x-found-in": "body" }, "threat_index": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatIndex", "x-found-in": "body" }, "threat_mapping": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatMapping", "x-found-in": "body" }, "threat_query": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatQuery", "x-found-in": "body" }, "concurrent_searches": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ConcurrentSearches", "x-found-in": "body" }, "items_per_search": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ItemsPerSearch", "x-found-in": "body" }, "threat_filters": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatFilters", "x-found-in": "body" }, "threat_indicator_path": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatIndicatorPath", "x-found-in": "body" }, "threat_language": { "$ref": "./_defs.json#/$defs/Security_Detections_API_KqlQueryLanguage", "x-found-in": "body" }, "anomaly_threshold": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AnomalyThreshold", "x-found-in": "body" }, "machine_learning_job_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_MachineLearningJobId", "x-found-in": "body" }, "history_window_start": { "$ref": "./_defs.json#/$defs/Security_Detections_API_HistoryWindowStart", "x-found-in": "body" }, "new_terms_fields": { "$ref": "./_defs.json#/$defs/Security_Detections_API_NewTermsFields", "x-found-in": "body" } }, "required": ["name", "description", "risk_score", "severity", "type", "invocationCount", "timeframeEnd"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rule-preview", "x-api": { "id": "security-detections-api.rule-preview", "name": "rule-preview", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/rules/preview", "x-destructive": true, "type": "object", "properties": { "enable_logged_requests": { "type": "boolean", "description": "Enables logging and returning in response ES queries, performed during rule execution", "x-found-in": "query" }, "actions": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleAction" }, "description": "Array defining the automated actions (notifications) taken when alerts are generated.", "x-found-in": "body" }, "alias_purpose": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SavedObjectResolveAliasPurpose", "x-found-in": "body" }, "alias_target_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SavedObjectResolveAliasTargetId", "x-found-in": "body" }, "author": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleAuthorArray", "x-found-in": "body" }, "building_block_type": { "$ref": "./_defs.json#/$defs/Security_Detections_API_BuildingBlockType", "x-found-in": "body" }, "description": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleDescription", "x-found-in": "body" }, "enabled": { "$ref": "./_defs.json#/$defs/Security_Detections_API_IsRuleEnabled", "x-found-in": "body" }, "exceptions_list": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleExceptionList" }, "x-found-in": "body" }, "false_positives": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleFalsePositiveArray", "x-found-in": "body" }, "from": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleIntervalFrom", "x-found-in": "body" }, "interval": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleInterval", "x-found-in": "body" }, "investigation_fields": { "$ref": "./_defs.json#/$defs/Security_Detections_API_InvestigationFields", "x-found-in": "body" }, "license": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleLicense", "x-found-in": "body" }, "max_signals": { "$ref": "./_defs.json#/$defs/Security_Detections_API_MaxSignals", "x-found-in": "body" }, "meta": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleMetadata", "x-found-in": "body" }, "name": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleName", "x-found-in": "body" }, "namespace": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AlertsIndexNamespace", "x-found-in": "body" }, "note": { "$ref": "./_defs.json#/$defs/Security_Detections_API_InvestigationGuide", "x-found-in": "body" }, "outcome": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SavedObjectResolveOutcome", "x-found-in": "body" }, "output_index": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AlertsIndex", "x-found-in": "body" }, "references": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleReferenceArray", "x-found-in": "body" }, "related_integrations": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RelatedIntegrationArray", "x-found-in": "body" }, "required_fields": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RequiredFieldInput" }, "description": "Elasticsearch fields and their types that need to be present for the rule to function.\n> info\n> The value of `required_fields` does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Use `required_fields` as an informational property to document the fields that the rule expects to be present in the data.\n", "x-found-in": "body" }, "response_actions": { "type": "array", "items": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ResponseAction" }, "x-found-in": "body" }, "risk_score": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RiskScore", "x-found-in": "body" }, "risk_score_mapping": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RiskScoreMapping", "x-found-in": "body" }, "rule_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleSignatureId", "x-found-in": "body" }, "rule_name_override": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleNameOverride", "x-found-in": "body" }, "setup": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SetupGuide", "x-found-in": "body" }, "severity": { "$ref": "./_defs.json#/$defs/Security_Detections_API_Severity", "x-found-in": "body" }, "severity_mapping": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SeverityMapping", "x-found-in": "body" }, "tags": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleTagArray", "x-found-in": "body" }, "threat": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatArray", "x-found-in": "body" }, "throttle": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleActionThrottle", "x-found-in": "body" }, "timeline_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimelineTemplateId", "x-found-in": "body" }, "timeline_title": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimelineTemplateTitle", "x-found-in": "body" }, "timestamp_override": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimestampOverride", "x-found-in": "body" }, "timestamp_override_fallback_disabled": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimestampOverrideFallbackDisabled", "x-found-in": "body" }, "to": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleIntervalTo", "x-found-in": "body" }, "version": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleVersion", "x-found-in": "body" }, "language": { "$ref": "./_defs.json#/$defs/Security_Detections_API_EsqlQueryLanguage", "x-found-in": "body" }, "query": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleQuery", "x-found-in": "body" }, "type": { "enum": ["esql"], "description": "Rule type", "x-found-in": "body" }, "alert_suppression": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AlertSuppression", "x-found-in": "body" }, "data_view_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_DataViewId", "x-found-in": "body" }, "event_category_override": { "$ref": "./_defs.json#/$defs/Security_Detections_API_EventCategoryOverride", "x-found-in": "body" }, "filters": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleFilterArray", "x-found-in": "body" }, "index": { "$ref": "./_defs.json#/$defs/Security_Detections_API_IndexPatternArray", "x-found-in": "body" }, "tiebreaker_field": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TiebreakerField", "x-found-in": "body" }, "timestamp_field": { "$ref": "./_defs.json#/$defs/Security_Detections_API_TimestampField", "x-found-in": "body" }, "invocationCount": { "type": "number", "x-found-in": "body" }, "timeframeEnd": { "type": "string", "x-found-in": "body" }, "saved_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SavedQueryId", "x-found-in": "body" }, "threshold": { "$ref": "./_defs.json#/$defs/Security_Detections_API_Threshold", "x-found-in": "body" }, "threat_index": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatIndex", "x-found-in": "body" }, "threat_mapping": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatMapping", "x-found-in": "body" }, "threat_query": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatQuery", "x-found-in": "body" }, "concurrent_searches": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ConcurrentSearches", "x-found-in": "body" }, "items_per_search": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ItemsPerSearch", "x-found-in": "body" }, "threat_filters": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatFilters", "x-found-in": "body" }, "threat_indicator_path": { "$ref": "./_defs.json#/$defs/Security_Detections_API_ThreatIndicatorPath", "x-found-in": "body" }, "threat_language": { "$ref": "./_defs.json#/$defs/Security_Detections_API_KqlQueryLanguage", "x-found-in": "body" }, "anomaly_threshold": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AnomalyThreshold", "x-found-in": "body" }, "machine_learning_job_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_MachineLearningJobId", "x-found-in": "body" }, "history_window_start": { "$ref": "./_defs.json#/$defs/Security_Detections_API_HistoryWindowStart", "x-found-in": "body" }, "new_terms_fields": { "$ref": "./_defs.json#/$defs/Security_Detections_API_NewTermsFields", "x-found-in": "body" } }, "required": ["name", "description", "risk_score", "severity", "type", "invocationCount", "timeframeEnd"] }

package/lib/cjs/kibana/json/security-detections-api.search-alerts.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "SearchAlerts", "x-api": { "id": "security-detections-api.search-alerts", "name": "search-alerts", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/signals/search", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Detections_API_QueryAlertsBodyParams", "x-found-in": "body", "x-body-root": true } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search-alerts", "x-api": { "id": "security-detections-api.search-alerts", "name": "search-alerts", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/signals/search", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Detections_API_QueryAlertsBodyParams", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-detections-api.set-alert-assignees.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "SetAlertAssignees", "x-api": { "id": "security-detections-api.set-alert-assignees", "name": "set-alert-assignees", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/signals/assignees", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SetAlertAssigneesBody", "x-found-in": "body", "x-body-root": true } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-alert-assignees", "x-api": { "id": "security-detections-api.set-alert-assignees", "name": "set-alert-assignees", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/signals/assignees", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SetAlertAssigneesBody", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-detections-api.set-alert-tags.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "SetAlertTags", "x-api": { "id": "security-detections-api.set-alert-tags", "name": "set-alert-tags", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/signals/tags", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SetAlertTagsBody", "x-found-in": "body", "x-body-root": true } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-alert-tags", "x-api": { "id": "security-detections-api.set-alert-tags", "name": "set-alert-tags", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/signals/tags", "x-destructive": true, "type": "object", "properties": { "body": { "$ref": "./_defs.json#/$defs/Security_Detections_API_SetAlertTagsBody", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/kibana/json/security-detections-api.set-alerts-status.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "SetAlertsStatus", "x-api": { "id": "security-detections-api.set-alerts-status", "name": "set-alerts-status", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/signals/status", "x-destructive": true, "type": "object", "properties": { "reason": { "$ref": "./_defs.json#/$defs/Security_Detections_API_Reason", "x-found-in": "body" }, "signal_ids": { "type": "array", "items": { "type": "string" }, "description": "List of alert ids. Use field `_id` on alert document or `kibana.alert.uuid`. Note: signals are a deprecated term for alerts.", "x-found-in": "body" }, "status": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AlertStatusExceptClosed", "x-found-in": "body" }, "conflicts": { "enum": ["abort", "proceed"], "x-found-in": "body" }, "query": { "type": "object", "additionalProperties": true, "x-found-in": "body" } }, "required": ["status"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-alerts-status", "x-api": { "id": "security-detections-api.set-alerts-status", "name": "set-alerts-status", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/signals/status", "x-destructive": true, "type": "object", "properties": { "reason": { "$ref": "./_defs.json#/$defs/Security_Detections_API_Reason", "x-found-in": "body" }, "signal_ids": { "type": "array", "items": { "type": "string" }, "description": "List of alert ids. Use field `_id` on alert document or `kibana.alert.uuid`. Note: signals are a deprecated term for alerts.", "x-found-in": "body" }, "status": { "$ref": "./_defs.json#/$defs/Security_Detections_API_AlertStatusExceptClosed", "x-found-in": "body" }, "conflicts": { "enum": ["abort", "proceed"], "x-found-in": "body" }, "query": { "type": "object", "additionalProperties": true, "x-found-in": "body" } }, "required": ["status"] }

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

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

package/lib/cjs/kibana/json/security-endpoint-exceptions-api.create-endpoint-list-item.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "CreateEndpointListItem", "x-api": { "id": "security-endpoint-exceptions-api.create-endpoint-list-item", "name": "create-endpoint-list-item", "namespace": "security-endpoint-exceptions-api" }, "x-method": "POST", "x-path": "/api/endpoint_list/items", "x-destructive": false, "type": "object", "properties": { "comments": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray", "x-found-in": "body" }, "description": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemDescription", "x-found-in": "body" }, "entries": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray", "x-found-in": "body" }, "item_id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId", "x-found-in": "body" }, "meta": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemMeta", "x-found-in": "body" }, "name": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemName", "x-found-in": "body" }, "os_types": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray", "x-found-in": "body" }, "tags": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemTags", "x-found-in": "body" }, "type": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemType", "x-found-in": "body" } }, "required": ["type", "name", "description", "entries"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "create-endpoint-list-item", "x-api": { "id": "security-endpoint-exceptions-api.create-endpoint-list-item", "name": "create-endpoint-list-item", "namespace": "security-endpoint-exceptions-api" }, "x-method": "POST", "x-path": "/api/endpoint_list/items", "x-destructive": false, "type": "object", "properties": { "comments": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemCommentArray", "x-found-in": "body" }, "description": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemDescription", "x-found-in": "body" }, "entries": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemEntryArray", "x-found-in": "body" }, "item_id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId", "x-found-in": "body" }, "meta": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemMeta", "x-found-in": "body" }, "name": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemName", "x-found-in": "body" }, "os_types": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemOsTypeArray", "x-found-in": "body" }, "tags": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemTags", "x-found-in": "body" }, "type": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemType", "x-found-in": "body" } }, "required": ["type", "name", "description", "entries"] }

package/lib/cjs/kibana/json/security-endpoint-exceptions-api.delete-endpoint-list-item.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "DeleteEndpointListItem", "x-api": { "id": "security-endpoint-exceptions-api.delete-endpoint-list-item", "name": "delete-endpoint-list-item", "namespace": "security-endpoint-exceptions-api" }, "x-method": "DELETE", "x-path": "/api/endpoint_list/items", "x-destructive": true, "type": "object", "properties": { "id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemId", "description": "Either `id` or `item_id` must be specified", "x-found-in": "query" }, "item_id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId", "description": "Either `id` or `item_id` must be specified", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete-endpoint-list-item", "x-api": { "id": "security-endpoint-exceptions-api.delete-endpoint-list-item", "name": "delete-endpoint-list-item", "namespace": "security-endpoint-exceptions-api" }, "x-method": "DELETE", "x-path": "/api/endpoint_list/items", "x-destructive": true, "type": "object", "properties": { "id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemId", "description": "Either `id` or `item_id` must be specified", "x-found-in": "query" }, "item_id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId", "description": "Either `id` or `item_id` must be specified", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-endpoint-exceptions-api.find-endpoint-list-items.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "FindEndpointListItems", "x-api": { "id": "security-endpoint-exceptions-api.find-endpoint-list-items", "name": "find-endpoint-list-items", "namespace": "security-endpoint-exceptions-api" }, "x-method": "GET", "x-path": "/api/endpoint_list/items/_find", "x-destructive": false, "type": "object", "properties": { "filter": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_NonEmptyString", "description": "Filters the returned results according to the value of the specified field,\nusing the `<field name>:<field value>` syntax.\n", "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": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_NonEmptyString", "description": "Determines which field is used to sort the results", "x-found-in": "query" }, "sort_order": { "enum": ["desc", "asc"], "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": "find-endpoint-list-items", "x-api": { "id": "security-endpoint-exceptions-api.find-endpoint-list-items", "name": "find-endpoint-list-items", "namespace": "security-endpoint-exceptions-api" }, "x-method": "GET", "x-path": "/api/endpoint_list/items/_find", "x-destructive": false, "type": "object", "properties": { "filter": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_NonEmptyString", "description": "Filters the returned results according to the value of the specified field,\nusing the `<field name>:<field value>` syntax.\n", "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": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_NonEmptyString", "description": "Determines which field is used to sort the results", "x-found-in": "query" }, "sort_order": { "enum": ["desc", "asc"], "description": "Determines the sort order, which can be `desc` or `asc`", "x-found-in": "query" } } }

package/lib/cjs/kibana/json/security-endpoint-exceptions-api.read-endpoint-list-item.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ReadEndpointListItem", "x-api": { "id": "security-endpoint-exceptions-api.read-endpoint-list-item", "name": "read-endpoint-list-item", "namespace": "security-endpoint-exceptions-api" }, "x-method": "GET", "x-path": "/api/endpoint_list/items", "x-destructive": false, "type": "object", "properties": { "id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemId", "description": "Either `id` or `item_id` must be specified", "x-found-in": "query" }, "item_id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId", "description": "Either `id` or `item_id` must be specified", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "read-endpoint-list-item", "x-api": { "id": "security-endpoint-exceptions-api.read-endpoint-list-item", "name": "read-endpoint-list-item", "namespace": "security-endpoint-exceptions-api" }, "x-method": "GET", "x-path": "/api/endpoint_list/items", "x-destructive": false, "type": "object", "properties": { "id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemId", "description": "Either `id` or `item_id` must be specified", "x-found-in": "query" }, "item_id": { "$ref": "./_defs.json#/$defs/Security_Endpoint_Exceptions_API_ExceptionListItemHumanId", "description": "Either `id` or `item_id` must be specified", "x-found-in": "query" } } }