Applies a bulk action to multiple Knowledge Base Entries

Base URL: https://{kibana_url}

POST /api/security_ai_assistant/knowledge_base/entries/_bulk_action

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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

create union anyOf[]: List of Knowledge Base Entries to create.; Any of:
delete object
update union anyOf[]: List of Knowledge Base Entries to update.; Any of:

Responses

Successful bulk operation request

application/json

attributes object required
knowledgeBaseEntriesCount integer: Total number of Knowledge Base Entries processed.
message string: Message describing the result of the bulk action.
statusCode integer: HTTP status code of the response.
success boolean: Indicates whether the bulk action was successful.

Bad Request response.

application/json

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl \
 --request POST 'http://localhost:5601/api/security_ai_assistant/knowledge_base/entries/_bulk_action' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"create":[{"name":"Runbook","type":"document","kbResource":"user","source":"manual","text":"Steps to triage an alert."}]}'

Request

Request example

{
  "create": [
    {
      "kbResource": "user",
      "name": "New Entry",
      "source": "manual",
      "text": "This is the content of the new entry.",
      "type": "document"
    }
  ],
  "delete": {
    "ids": [
      "789"
    ]
  },
  "update": [
    {
      "id": "123",
      "kbResource": "user",
      "name": "Updated Entry",
      "source": "manual",
      "text": "Updated content.",
      "type": "document"
    }
  ]
}

Response

{
  "attributes": {
    "results": {
      "created": [
        {
          "createdAt": "2024-01-15T10:00:00.000Z",
          "createdBy": "user@example.com",
          "global": false,
          "id": "456",
          "kbResource": "user",
          "name": "New Entry",
          "namespace": "default",
          "source": "manual",
          "text": "This is the content of the new entry.",
          "type": "document",
          "updatedAt": "2024-01-15T10:00:00.000Z",
          "updatedBy": "user@example.com"
        }
      ],
      "deleted": [
        "789"
      ],
      "skipped": [],
      "updated": [
        {
          "createdAt": "2024-01-14T09:00:00.000Z",
          "createdBy": "user@example.com",
          "global": false,
          "id": "123",
          "kbResource": "user",
          "name": "Updated Entry",
          "namespace": "default",
          "source": "manual",
          "text": "Updated content.",
          "type": "document",
          "updatedAt": "2024-01-15T10:00:00.000Z",
          "updatedBy": "user@example.com"
        }
      ]
    },
    "summary": {
      "failed": 0,
      "skipped": 0,
      "succeeded": 3,
      "total": 3
    }
  },
  "knowledgeBaseEntriesCount": 3,
  "message": "Bulk action completed successfully.",
  "statusCode": 200,
  "success": true
}

{
  "error": "Bad Request",
  "message": "Invalid request body.",
  "statusCode": 400
}

Authentication

Request body { }

Responses

Request body