Read a KnowledgeBase for a resource

Base URL: https://{kibana_url}

GET /api/security_ai_assistant/knowledge_base/{resource}

Auth

Read a knowledge base with a specific resource identifier.

Path parameters

resource string required: The KnowledgeBase resource value.; Example: kb12345

Responses

Indicates a successful call.

application/json

defend_insights_exists boolean: Indicates if Defend Insights documentation exists in the KnowledgeBase.
elser_exists boolean: Indicates if the ELSER model exists for the KnowledgeBase.
is_setup_available boolean: Indicates if the setup process is available for the KnowledgeBase.
is_setup_in_progress boolean: Indicates if the setup process is currently in progress.
product_documentation_status string: The status of the product documentation in the KnowledgeBase.
security_labs_exists boolean: Indicates if Security Labs documentation exists in the KnowledgeBase.
user_data_exists boolean: Indicates if user data exists in the KnowledgeBase.

Bad Request response.

application/json

error string: A short description of the error.
message string: A detailed error message.
statusCode number: The HTTP status code of the error.

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl \
 --request GET 'http://localhost:5601/api/security_ai_assistant/knowledge_base/kb12345' \
 --header "Authorization: $API_KEY"

Response

{
  "defend_insights_exists": true,
  "elser_exists": false,
  "is_setup_available": true,
  "is_setup_in_progress": true,
  "product_documentation_status": "installed",
  "security_labs_exists": false,
  "user_data_exists": true
}

{
  "error": "Bad Request",
  "message": "Invalid resource ID provided.",
  "statusCode": 400
}