Manage Coralogix alerts, alert events, scheduler rules, incidents, cases, and SLOs. Use for creating/updating alert definitions, managing incident lifecycle, and configuring service level objectives.
Covers all alerting, incident, case, and SLO operations via the Coralogix Management API.
Set environment variables before running any command:
export CORALOGIX_API_KEY="your-api-key"
export CORALOGIX_REGION="eu2" # eu1, eu2, us1, us2, ap1, ap2, ap3
See coralogix-core skill for auth setup and region details.
.augment/skills/coralogix-alerting/scripts/alerting_api.py
Self-contained — no pip dependencies. Embeds the CoralogixClient class inline.
python alerting_api.py --action <action> [--body '{...}'] [--params '{...}'] [--path-params '{...}']
--body — JSON request body (POST/PUT/PATCH)--params — JSON query parameters--path-params — JSON path parameter substitutions (e.g. {"id":"abc-123"})--region — Override region (default: $CORALOGIX_REGION or eu2)--api-key — Override API key (default: $CORALOGIX_API_KEY)--dry-run — Show what a POST/PUT/DELETE/PATCH would do without executing it (GET operations still run normally)| Action | Method | Path |
|---|---|---|
list-alerts | GET | /alerts/alerts-general/v3 |
create-alert | POST | /alerts/alerts-general/v3 |
replace-alert | PUT | /alerts/alerts-general/v3 |
get-alert | GET | /alerts/alerts-general/v3/{id} |
delete-alert | DELETE | /alerts/alerts-general/v3/{id} |
set-alert-active | POST | /alerts/alerts-general/v3/{id}:setActive |
get-alert-by-version | GET | /alerts/alerts-general/v3/alert-version-id/{alert_version_id} |
bulk-replace-alerts | PUT | /alerts/alerts-general/v3/bulk |
download-alerts | GET | /alerts/alerts-general/v3/download |
alert-filter-option-counts | GET | /alerts/alerts-general/v3/filter-option-counts |
| Action | Method | Path |
|---|---|---|
list-scheduler-rules | GET | /v1/alert-scheduler-rules/bulk |
create-scheduler-rule | POST | /v1/alert-scheduler-rules |
update-scheduler-rule | PUT | /v1/alert-scheduler-rules |
get-scheduler-rule | GET | /v1/alert-scheduler-rules/{alert_scheduler_rule_id} |
delete-scheduler-rule | DELETE | /v1/alert-scheduler-rules/{alert_scheduler_rule_id} |
create-bulk-scheduler-rules | POST | /v1/alert-scheduler-rules/bulk |
update-bulk-scheduler-rules | PUT | /v1/alert-scheduler-rules/bulk |
| Action | Method | Path |
|---|---|---|
alert-event-stats | GET | /v3/alert-event-stats |
get-alert-event | GET | /v3/alert-event/{id} |
| Action | Method | Path |
|---|---|---|
list-events | GET | /alerts/events/v3 |
list-alert-events | GET | /alerts/events/v3/alert-events |
batch-get-events | GET | /alerts/events/v3/batch |
events-count | GET | /alerts/events/v3/count |
events-statistics | GET | /alerts/events/v3/statistics |
get-event | GET | /alerts/events/v3/{id} |
| Action | Method | Path |
|---|---|---|
list-incidents | GET | /incidents/incidents/v1 |
get-incident | GET | /incidents/incidents/v1/{id} |
batch-get-incidents | GET | /incidents/incidents/v1/batch |
acknowledge-incidents | POST | /incidents/incidents/v1/acknowledge |
resolve-incidents | POST | /incidents/incidents/v1/resolve |
close-incidents | POST | /incidents/incidents/v1/close |
assign-incidents | POST | /incidents/incidents/v1/by-user |
unassign-incidents | DELETE | /incidents/incidents/v1/by-user |
incident-aggregations | GET | /incidents/incidents/v1/aggregations |
list-incident-events | GET | /incidents/incidents/v1/events |
incident-events-count | GET | /incidents/incidents/v1/events/count |
incident-event-filter-values | GET | /incidents/incidents/v1/events/filter-values |
get-incident-by-event | GET | /incidents/incidents/v1/events/{event_id} |
ack-incident-by-event | POST | /incidents/incidents/v1/events/{event_id}/acknowledge |
resolve-incident-by-event | POST | /incidents/incidents/v1/events/{event_id}/resolve |
incident-filter-values | POST | /incidents/incidents/v1/filter-values |
get-incident-events | GET | /incidents/incidents/v1/{incident_id}/events |
| Action | Method | Path |
|---|---|---|
list-cases | POST | /cases/cases/v1 |
get-case | GET | /cases/cases/v1/{id} |
update-case | PATCH | /cases/cases/v1/{id} |
acknowledge-case | POST | /cases/cases/v1/{id}:acknowledge |
assign-case | POST | /cases/cases/v1/{id}:assign |
close-case | POST | /cases/cases/v1/{id}:close |
resolve-case | POST | /cases/cases/v1/{id}:resolve |
set-case-priority | POST | /cases/cases/v1/{id}:setPriorityOverride |
unassign-case | POST | /cases/cases/v1/{id}:unassign |
unset-case-priority | POST | /cases/cases/v1/{id}:unsetPriorityOverride |
case-filter-values | POST | /cases/cases/v1:get-filter-values |
| Action | Method | Path |
|---|---|---|
create-case-comment | POST | /cases/cases/v1/events/comment/{case_id} |
delete-case-comment | DELETE | /cases/cases/v1/events/comment/{event_id} |
update-case-comment | PATCH | /cases/cases/v1/events/comment/{event_id} |
list-case-events | GET | /cases/cases/v1/events/{case_id} |
get-case-event | GET | /cases/cases/v1/events/{event_id} |
| Action | Method | Path |
|---|---|---|
list-service-slos | GET | /apm/apm-slo/v1 |
create-service-slo | POST | /apm/apm-slo/v1 |
replace-service-slo | PUT | /apm/apm-slo/v1 |
batch-get-service-slos | GET | /apm/apm-slo/v1/batch |
get-service-slo | GET | /apm/apm-slo/v1/{id} |
delete-service-slo | DELETE | /apm/apm-slo/v1/{id} |
| Action | Method | Path |
|---|---|---|
list-slos | GET | /v1/slo/slos |
create-slo | POST | /v1/slo/slos |
replace-slo | PUT | /v1/slo/slos |
get-slo | GET | /v1/slo/slos/{id} |
delete-slo | DELETE | /v1/slo/slos/{id} |
validate-slo | POST | /v1/slo/slos/validate |
slo-zero-state | GET | /v1/slo/slos/zeroState |
batch-execute-slos | POST | /v1/slo/slos:batchExecute |
batch-get-slos | GET | /v1/slo/slos:batchGet |
| Action | Method | Path |
|---|---|---|
list-entity-types | GET | /notifications/notification-center/v1/entity-types |
list-entity-subtypes | GET | /notifications/notification-center/v1/entity-types/{entity_type}/entity-subtypes |
# List all alert definitions
python alerting_api.py --action list-alerts
# Get specific alert
python alerting_api.py --action get-alert --path-params '{"id":"123e4567-e89b-12d3-a456-426614174000"}'
# Create alert
python alerting_api.py --action create-alert --body '{"alertDefProperties": {...}}'
# Enable/disable alert
python alerting_api.py --action set-alert-active --path-params '{"id":"alert-id"}' --params '{"active":true}'
# List incidents (with pagination)
python alerting_api.py --action list-incidents --params '{"pagination":{"pageSize":20}}'
# Acknowledge incidents
python alerting_api.py --action acknowledge-incidents --params '{"incident_ids":["id1","id2"]}'
# Resolve incidents
python alerting_api.py --action resolve-incidents --params '{"incident_ids":["id1"]}'
# List cases
python alerting_api.py --action list-cases --body '{"pagination":{"pageSize":10}}'
# Get case
python alerting_api.py --action get-case --path-params '{"id":"case-uuid"}'
# Create case comment
python alerting_api.py --action create-case-comment --path-params '{"case_id":"case-uuid"}' --body '{"text":"Investigating now"}'
# List Service SLOs
python alerting_api.py --action list-service-slos
# Create SLO
python alerting_api.py --action create-slo --body '{"name":"API Success Rate","sloTarget":0.99,"period":"7_DAYS","indicator":{...}}'
# Dry-run: preview a POST without executing it
python alerting_api.py --action create-alert --body '{"name":"test"}' --dry-run
# Dry-run on a GET: runs normally (dry-run has no effect on reads)
python alerting_api.py --action list-alerts --dry-run
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Client/configuration error |
| 2 | API error (4xx/5xx) |
| 3 | Authentication error (401/403) |
Authorization: <key> — no Bearer prefix. Using Bearer will cause 401 errors.certifi as a fallback automatically, but if you see SSL errors, run: pip install certifi.--body. Invalid JSON will fail at the client, not the API.--max-output flag truncates the JSON response. If you get truncated data, increase the limit or omit the flag.See references/ALERT_SCHEMAS.md for key request/response schemas.
See coralogix-core skill for authentication, region config, and connectivity checks.