Overview
Updated at:
Prerequisites, endpoint assembly, and authentication for the Security API, plus available interfaces for protection and policies and alerts, and error codes.
NoteBefore calling, configure Authentication. For error handling, see Errors.
The Security API provides query and alert export capabilities for Agent security protection data. The path prefix is /api/v1/agentstudio/security.
Prerequisites
- Activate Alibaba Cloud Bailian and create an API Key.
- Get the workspace ID: view it in the drop-down menu at the top right of the Bailian console, in the form
{workspace_id}.
Endpoint
The API base URL is assembled from the workspace and region:
https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/security
workspace_id: workspace IDregion: region ID, currently onlycn-beijing
Available APIs
Protection
| Capability | Method | Path |
|---|---|---|
| Get protection overview | GET | /overview |
| Get Agent assets | GET | /asset_summary |
Policies and alerts
| Capability | Method | Path |
|---|---|---|
| List security policies | GET | /policies |
| List alerts | GET | /agent_logs |
| Get alert details | GET | /agent_logs/{alert_id} |
| Export alerts | POST | /export_agent_logs |
| Get export status | GET | /export_status |
Is this page helpful?