Skip to main content

Overview

Overview of the Security API, covering 7 interfaces for protection overview, Agent assets, security policies, and alert query and export.

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": "12000094", "errorMsg": "Alert query failed"}
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.

Error Codes

Error CodeHTTP StatusDescriptionSuggestion
12000093503Cloud security service errorThe affected capability is temporarily unavailable, retry later
12000094503Alert query failedRetry later
Before calling, configure Authentication. For error handling, see Error Codes.