Skip to main content

Get protection overview

Query protection overview data, always for the last 24 hours. Returns protection capability switches, per-module protection coverage switches, and interception statistics.

Prerequisites

Configure the endpoint and authentication first. See API overview and authentication.

Endpoint

GET /overview Query protection overview data, always for the last 24 hours.

Request example

curl -X GET "$BASE_URL/overview" \
  -H "Authorization: Bearer $BAILIAN_API_KEY"
BASE_URL is https://{workspace_id}.cn-beijing.maas.aliyuncs.com/api/v1/agentstudio/security, and BAILIAN_API_KEY is your Alibaba Cloud Bailian API Key.

Response body

FieldTypeDescription
capabilitiesarrayProtection capability switches in fixed order. Each item contains key and enabled
protectionarrayPer-module protection coverage switches, same structure as capabilities
content_safetyobjectContent security statistics card with hit (interception or anomaly count) and scanned (total detection count)
file_scanobjectFile scan statistics card with hit and scanned
skill_scanobjectSkill scan statistics card with hit and scanned
capabilities key values: agent_identity, content_safety, supply_chain_scan, credential_isolation, session_lifecycle. protection key values: flow_agent, managed_agent, knowledge_base, memory, mcp, external_agent. The top-level totals: the scan total is the sum of all scanned values, and the risk count is the sum of all hit values.

Response example

{
  "success": true,
  "data": {
    "capabilities": [
      {"key": "agent_identity",       "enabled": true},
      {"key": "content_safety",        "enabled": false},
      {"key": "supply_chain_scan",     "enabled": true},
      {"key": "credential_isolation",  "enabled": true},
      {"key": "session_lifecycle",     "enabled": true}
    ],
    "protection": [
      {"key": "flow_agent",       "enabled": true},
      {"key": "managed_agent",    "enabled": true},
      {"key": "knowledge_base",   "enabled": true},
      {"key": "memory",           "enabled": false},
      {"key": "mcp",              "enabled": true},
      {"key": "external_agent",   "enabled": false}
    ],
    "content_safety": {"hit": 12, "scanned": 3860},
    "file_scan":      {"hit": 3,  "scanned": 96},
    "skill_scan":     {"hit": 1,  "scanned": 20}
  }
}
Managed Agent API
Flow Agent API
Sandbox API
RAG API
Long-term Memory
ParseX API
Security API
Framework Integration