Prerequisites, endpoint assembly, and authentication for the Security API, plus available interfaces for protection and policies and alerts, and error codes.
Before calling, configure Authentication. For error handling, see Errors.
/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:
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 |