Apply a bulk action to prompts
https://{kibana_url}
- POST /api/security_ai_assistant/prompts/_bulk_action
Apply a bulk action to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs. This action allows for bulk create, update, or delete operations.
Request
-
createobject -
List of prompts to be created.
-
categoriesstring -
List of categories for the prompt.
-
colorstring -
The color associated with the prompt.
-
consumerstring -
The consumer associated with the prompt.
-
contentstringrequired -
The content of the prompt.
-
isDefaultboolean -
Whether this prompt should be the default.
-
isNewConversationDefaultboolean -
Whether this prompt should be the default for new conversations.
-
namestringrequired -
The name of the prompt.
-
deleteobject -
Criteria for deleting prompts in bulk.
-
updateobject -
List of prompts to be updated.
-
categoriesstring -
The updated categories for the prompt.
-
colorstring -
The updated color associated with the prompt.
-
consumerstring -
The updated consumer for the prompt.
-
contentstring -
The updated content for the prompt.
-
idstringrequired -
The ID of the prompt to update.
-
isDefaultboolean -
Whether this prompt should be the default.
-
isNewConversationDefaultboolean -
Whether the prompt should be the default for new conversations.
Responses
Indicates a successful call with the results of the bulk action.
-
attributesobjectrequired -
errorsobject -
err_codestring -
A code representing the error type.
-
messagestringrequired -
A message describing the error encountered.
-
promptsobjectrequired -
List of prompts that encountered errors.
-
status_codeintegerrequired -
The HTTP status code associated with the error.
-
resultsrequired -
createdobjectrequired -
List of prompts that were created.
-
categoriesstring -
Categories associated with the prompt.
-
colorstring -
The color associated with the prompt.
-
consumerstring -
The consumer that the prompt is associated with.
-
contentstringrequired -
The content of the prompt.
-
createdAtstring -
The timestamp of when the prompt was created.
-
createdBystring -
The user who created the prompt.
-
idstring · min: 1required -
A string that does not contain only whitespace characters.
-
isDefaultboolean -
Whether this prompt is the default.
-
isNewConversationDefaultboolean -
Whether this prompt is the default for new conversations.
-
namestringrequired -
The name of the prompt.
-
namespacestring -
Kibana space where the prompt is located.
-
timestampstring · min: 1 -
A string that represents a timestamp in ISO 8601 format and does not contain only whitespace characters.
-
updatedAtstring -
The timestamp of when the prompt was last updated.
-
updatedBystring -
The user who last updated the prompt.
-
deletedstringrequired -
List of IDs of prompts that were deleted.
-
skippedobjectrequired -
List of prompts that were skipped.
-
idstringrequired -
The ID of the prompt that was skipped.
-
namestring -
The name of the prompt that was skipped.
-
skip_reasonrequired -
Reason why a prompt was skipped during the bulk action.
-
Values:
PROMPT_FIELD_NOT_MODIFIED -
updatedobjectrequired -
List of prompts that were updated.
-
messagestring -
A message describing the result of the bulk action.
-
prompts_countinteger -
The number of prompts processed in the bulk action.
-
status_codeinteger -
The HTTP status code of the response.
-
successboolean -
Indicates if the bulk action was successful.
Bad Request response.
-
errorstring -
A short error message.
-
messagestring -
A detailed error message.
-
statusCodenumber -
The HTTP status code for the error.