Applies a bulk action to multiple Knowledge Base Entries
https://{kibana_url}
- POST /api/security_ai_assistant/knowledge_base/entries/_bulk_action
- POST /s/{space_id}/api/security_ai_assistant/knowledge_base/entries/_bulk_action
Refer to Spaces for more information.
The bulk action is applied to all Knowledge Base Entries that match the filter or to the list of Knowledge Base Entries by their IDs.
Request
-
create -
List of Knowledge Base Entries to create.
-
globalboolean -
Whether this Knowledge Base Entry is global, defaults to false.
-
namestringrequired -
Name of the Knowledge Base Entry.
-
namespacestring -
Kibana Space, defaults to 'default' space.
-
usersobject -
Users who have access to the Knowledge Base Entry, defaults to current user. Empty array provides access to all users.
-
kbResource -
Knowledge Base resource name for grouping entries, e.g. 'security_labs', 'user', etc.
-
Values:
security_labsuser -
sourcestringrequired -
Source document name or filepath.
-
textstringrequired -
Knowledge Base Entry content.
-
requiredboolean -
Whether this resource should always be included, defaults to false.
-
globalboolean -
Whether this Knowledge Base Entry is global, defaults to false.
-
namestringrequired -
Name of the Knowledge Base Entry.
-
namespacestring -
Kibana Space, defaults to 'default' space.
-
usersobject -
Users who have access to the Knowledge Base Entry, defaults to current user. Empty array provides access to all users.
-
descriptionstringrequired -
Description for when this index or data stream should be queried for Knowledge Base content. Passed to the LLM as a tool description.
-
fieldstringrequired -
Field to query for Knowledge Base content.
-
indexstringrequired -
Index or Data Stream to query for Knowledge Base content.
-
queryDescriptionstringrequired -
Description of query field used to fetch Knowledge Base content. Passed to the LLM as part of the tool input schema.
-
inputSchemaobject -
Array of objects defining the input schema, allowing the LLM to extract structured data to be used in retrieval.
-
descriptionstringrequired -
Description of the field.
-
fieldNamestringrequired -
Name of the field.
-
fieldTypestringrequired -
Type of the field.
-
outputFieldsstring -
Fields to extract from the query result, defaults to all fields if not provided or empty.
-
deleteobject -
update -
List of Knowledge Base Entries to update.
-
globalboolean -
Whether this Knowledge Base Entry is global, defaults to false.
-
idstring · min: 1required -
A string that does not contain only whitespace characters.
-
namestringrequired -
Name of the Knowledge Base Entry.
-
namespacestring -
Kibana Space, defaults to 'default' space.
-
usersobject -
Users who have access to the Knowledge Base Entry, defaults to current user. Empty array provides access to all users.
-
kbResource -
Knowledge Base resource name for grouping entries, e.g. 'security_labs', 'user', etc.
-
Values:
security_labsuser -
sourcestringrequired -
Source document name or filepath.
-
textstringrequired -
Knowledge Base Entry content.
-
requiredboolean -
Whether this resource should always be included, defaults to false.
-
globalboolean -
Whether this Knowledge Base Entry is global, defaults to false.
-
idstring · min: 1required -
A string that does not contain only whitespace characters.
-
namestringrequired -
Name of the Knowledge Base Entry.
-
namespacestring -
Kibana Space, defaults to 'default' space.
-
usersobject -
Users who have access to the Knowledge Base Entry, defaults to current user. Empty array provides access to all users.
-
descriptionstringrequired -
Description for when this index or data stream should be queried for Knowledge Base content. Passed to the LLM as a tool description.
-
fieldstringrequired -
Field to query for Knowledge Base content.
-
indexstringrequired -
Index or Data Stream to query for Knowledge Base content.
-
queryDescriptionstringrequired -
Description of query field used to fetch Knowledge Base content. Passed to the LLM as part of the tool input schema.
-
inputSchemaobject -
Array of objects defining the input schema, allowing the LLM to extract structured data to be used in retrieval.
-
descriptionstringrequired -
Description of the field.
-
fieldNamestringrequired -
Name of the field.
-
fieldTypestringrequired -
Type of the field.
-
outputFieldsstring -
Fields to extract from the query result, defaults to all fields if not provided or empty.
Responses
Successful bulk operation request
-
attributesobjectrequired -
errorsobject -
List of errors encountered during the bulk action.
-
err_codestring -
Specific error code for the issue.
-
knowledgeBaseEntriesobjectrequired -
List of Knowledge Base Entries that encountered the error.
-
messagestringrequired -
Error message describing the issue.
-
statusCodeintegerrequired -
HTTP status code associated with the error.
-
results -
created -
List of Knowledge Base Entries that were successfully created.
-
globalbooleanrequired -
Whether this Knowledge Base Entry is global, defaults to false.
-
namestringrequired -
Name of the Knowledge Base Entry.
-
namespacestringrequired -
Kibana Space, defaults to 'default' space.
-
usersobjectrequired -
Users who have access to the Knowledge Base Entry, defaults to current user. Empty array provides access to all users.
-
createdAtstringrequired -
Time the Knowledge Base Entry was created.
-
createdBystringrequired -
User who created the Knowledge Base Entry.
-
idstring · min: 1required -
A string that does not contain only whitespace characters.
-
updatedAtstringrequired -
Time the Knowledge Base Entry was last updated.
-
updatedBystringrequired -
User who last updated the Knowledge Base Entry.
-
kbResource -
Knowledge Base resource name for grouping entries, e.g. 'security_labs', 'user', etc.
-
Values:
security_labsuser -
sourcestringrequired -
Source document name or filepath.
-
textstringrequired -
Knowledge Base Entry content.
-
requiredboolean -
Whether this resource should always be included, defaults to false.
-
globalbooleanrequired -
Whether this Knowledge Base Entry is global, defaults to false.
-
namestringrequired -
Name of the Knowledge Base Entry.
-
namespacestringrequired -
Kibana Space, defaults to 'default' space.
-
usersobjectrequired -
Users who have access to the Knowledge Base Entry, defaults to current user. Empty array provides access to all users.
-
createdAtstringrequired -
Time the Knowledge Base Entry was created.
-
createdBystringrequired -
User who created the Knowledge Base Entry.
-
idstring · min: 1required -
A string that does not contain only whitespace characters.
-
updatedAtstringrequired -
Time the Knowledge Base Entry was last updated.
-
updatedBystringrequired -
User who last updated the Knowledge Base Entry.
-
descriptionstringrequired -
Description for when this index or data stream should be queried for Knowledge Base content. Passed to the LLM as a tool description.
-
fieldstringrequired -
Field to query for Knowledge Base content.
-
indexstringrequired -
Index or Data Stream to query for Knowledge Base content.
-
queryDescriptionstringrequired -
Description of query field used to fetch Knowledge Base content. Passed to the LLM as part of the tool input schema.
-
inputSchemaobject -
Array of objects defining the input schema, allowing the LLM to extract structured data to be used in retrieval.
-
descriptionstringrequired -
Description of the field.
-
fieldNamestringrequired -
Name of the field.
-
fieldTypestringrequired -
Type of the field.
-
outputFieldsstring -
Fields to extract from the query result, defaults to all fields if not provided or empty.
-
deletedstringrequired -
List of IDs of Knowledge Base Entries that were successfully deleted.
-
skippedobjectrequired -
List of Knowledge Base Entries that were skipped during the bulk action.
-
idstringrequired -
ID of the skipped Knowledge Base Entry.
-
namestring -
Name of the skipped Knowledge Base Entry.
-
skip_reason -
Reason why a Knowledge Base Entry was skipped during the bulk action.
-
Values:
KNOWLEDGE_BASE_ENTRY_NOT_MODIFIED -
updated -
List of Knowledge Base Entries that were successfully updated.
-
summary -
failedintegerrequired -
Number of Knowledge Base Entries that failed during the bulk action.
-
skippedintegerrequired -
Number of Knowledge Base Entries that were skipped during the bulk action.
-
succeededintegerrequired -
Number of Knowledge Base Entries that were successfully processed during the bulk action.
-
totalintegerrequired -
Total number of Knowledge Base Entries involved in the bulk action.
-
knowledgeBaseEntriesCountinteger -
Total number of Knowledge Base Entries processed.
-
messagestring -
Message describing the result of the bulk action.
-
statusCodeinteger -
HTTP status code of the response.
-
successboolean -
Indicates whether the bulk action was successful.
Generic Error
-
errorstringrequired -
Error type or category.
-
messagestringrequired -
Detailed error message.
-
statusCodenumberrequired -
HTTP status code of the error.