Security AI Assistant API

Read a KnowledgeBase

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/security_ai_assistant/knowledge_base</span></div>

Refer to Spaces for more information.

Read a single KB

get/api/security_ai_assistant/knowledge_base

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/security_ai_assistant/knowledge_base
  • Auth
    • API key in header Authorization
    • or HTTP basic

Response

Indicates a successful call.

defend_insights_existsboolean

Indicates if Defend Insights documentation exists in the KnowledgeBase.

elser_existsboolean

Indicates if the ELSER model exists for the KnowledgeBase.

is_setup_availableboolean

Indicates if the setup process is available for the KnowledgeBase.

is_setup_in_progressboolean

Indicates if the setup process is currently in progress.

product_documentation_statusstring

The status of the product documentation in the KnowledgeBase.

security_labs_existsboolean

Indicates if Security Labs documentation exists in the KnowledgeBase.

user_data_existsboolean

Indicates if user data exists in the KnowledgeBase.

Example response

{
  "defend_insights_exists": true,
  "elser_exists": true,
  "is_setup_available": true,
  "product_documentation_status": "complete",
  "security_labs_exists": true
}

Changes

No operation changes recorded.