public-api
public-alerts

List Inbox Alerts Sdk

List inbox alerts that can be acknowledged/resolved/dismissed.

Unlike the list endpoint, inbox alerts are the actual alert instances that support lifecycle actions like acknowledge(), resolve(), dismiss().

SDK Usage:

from anomalyarmor import Client
client = Client()

# Get all new alerts
alerts = client.alerts.list_inbox(state="new")
for alert in alerts:
    print(f"[{alert.severity}] {alert.title}")
    # Acknowledge this alert
    client.alerts.acknowledge(alert.id, notes="Investigating")
get/api/v1/sdk/alerts/inbox

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/sdk/alerts/inbox
  • Auth: none declared

Query parameters

statestring nullable

Filter by state: new, acknowledged, resolved, dismissed

severitystring nullable

Filter by severity: info, warning, critical

event_typestring nullable

Filter by event type: freshness_sla_violation, schema_change, etc.

limitinteger
offsetinteger

Headers

Authorizationstring

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.