Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.adrian.secureagentics.ai/llms.txt

Use this file to discover all available pages before exploring further.

Alerts define notification rules that tell Secureagentics where and how to deliver notifications when specific conditions are met — such as a policy violation, a detected anomaly, or an agent going offline. You can route alerts to email, Slack, or any HTTP webhook endpoint.

​
Create an alert

POST /v1/alerts Creates a new alert and returns the alert object. Once created, the alert is active immediately and will trigger notifications when its conditions are matched.

​
Request body

​
name
string
required
Human-readable name for the alert, unique within your account.
​
type
string
required
The kind of event that triggers this alert. One of: policy_violation, anomaly_detected, agent_down, rate_limit_exceeded.
​
channel
string
required
The delivery channel for notifications. One of: email, slack, webhook.
​
destination
string
required
The delivery target for the channel. Provide an email address for email, a Slack incoming webhook URL for slack, or an HTTPS URL for webhook.
​
conditions
object
Optional filters that narrow when the alert fires. Supported filter keys:
  • agent_id (string) — Only trigger for events from this agent.
  • severity (string) — Only trigger for events at or above this severity level. One of: low, medium, high, critical.
​
agent_id
string
Scope the alert to a specific agent. Equivalent to setting conditions.agent_id. If both are provided, conditions.agent_id takes precedence.

​
Response fields

​
id
string
required
Unique alert identifier, prefixed with alr_.
​
name
string
required
The alert name.
​
type
string
required
The event type that triggers the alert.
​
channel
string
required
The delivery channel: email, slack, or webhook.
​
destination
string
required
The delivery target for the channel.
​
conditions
object
The filter conditions configured for this alert.
​
agent_id
string
The agent this alert is scoped to, or null if it applies to all agents.
​
created_at
string
required
ISO 8601 timestamp of when the alert was created.
​
status
string
required
Current alert status. One of: active, inactive.
cURL
curl --request POST \
  --url https://api.secureagentics.ai/v1/alerts \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "critical-policy-violations",
    "type": "policy_violation",
    "channel": "slack",
    "destination": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXX",
    "conditions": {
      "severity": "critical"
    },
    "agent_id": "agt_01j9xkz2m3n4p5q6r7s8t9u0"
  }'

​
List alerts

GET /v1/alerts Returns a paginated list of all alerts configured in your account.

​
Query parameters

​
limit
integer
default:"20"
Maximum number of alerts to return per page. Accepted range: 1–100.
​
offset
integer
default:"0"
Number of alerts to skip before returning results. Use for pagination.

​
Response fields

​
items
object[]
required
Array of alert objects.
​
total
integer
required
Total number of alerts in your account, regardless of pagination.
cURL
curl --request GET \
  --url "https://api.secureagentics.ai/v1/alerts?limit=20&offset=0" \
  --header "Authorization: Bearer YOUR_API_KEY"

​
Delete an alert

DELETE /v1/alerts/{id} Permanently deletes an alert. Once deleted, the alert stops firing and no further notifications are sent. Returns 204 No Content on success.
Deleting an alert takes effect immediately. Any triggering conditions that occur after deletion will not generate notifications.

​
Path parameters

​
id
string
required
The alert ID, prefixed with alr_.
cURL
curl --request DELETE \
  --url https://api.secureagentics.ai/v1/alerts/alr_01j9xkz2m3n4p5q6r7s8t9u0 \
  --header "Authorization: Bearer YOUR_API_KEY"