API Reference

Updated at:

API overview of the Security module, covering protection overview, Agent assets, security policies, and risk alerts.

The Security module provides 7 interfaces for querying the protection overview and Agent assets, viewing security policies and risk alerts, and exporting alert records. The path prefix is /api/v1/agentstudio/security.

API List

APIPathMethodInputPagination
Protection Overview/overviewGETNoneNo
Agent Assets/asset_summaryGETNoneNo
Security Policies/policiesGETNoneNo
Alert List/agent_logsGETYesCursor
Alert Details/agent_logs/{alert_id}GETYesNo
Export Alerts/export_agent_logsPOSTYesNo
Export Status/export_statusGETYesNo

Common Conventions

All APIs share the same response structure:

// Success
{"success": true, "data": { }}

// Failure
{"success": false, "errorCode": "12000092", "errorMsg": "No permission to create the service-linked role"}

When individual data items are unavailable, the API does not return an error: the corresponding field returns null (or available: false in some scenarios), without affecting the overall response.

See Security API overview and authentication for request parameters, response parameters, and error codes of each interface.