Applies a bulk action to multiple Knowledge Base Entries

Server: 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.

Request

Responses

Successful bulk operation request

application/json

Bad Request response.

application/json

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
}

Request { create , delete , update , }

Responses

Request