Read a KnowledgeBase for a resource

View as Markdown
GET /api/security_ai_assistant/knowledge_base/{resource}
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/security_ai_assistant/knowledge_base/{resource}

Refer to Spaces for more information.

Read a knowledge base with a specific resource identifier.

Path parameters

  • resource string Required

    The KnowledgeBase resource value.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • 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.
  • 400 application/json

    Generic Error

    Hide response attributes Show response attributes object
    • error string

      A short description of the error.

    • message string

      A detailed error message.

    • statusCode number

      The HTTP status code of the error.
GET /api/security_ai_assistant/knowledge_base/{resource} 
curl \
 --request GET 'https://localhost:5601/api/security_ai_assistant/knowledge_base/kb12345' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "elser_exists": false,
  "user_data_exists": true,
  "is_setup_available": true,
  "is_setup_in_progress": true,
  "security_labs_exists": false,
  "defend_insights_exists": true,
  "product_documentation_status": "installed"
}