Coralogix Alerting

• --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)

Available Actions

Alert Definitions (10)

Alert Scheduler Rules (7)

Alert Events Service (2)

Events Service (6)

Incidents (17)

Cases (11)

Case Events (5)

Service SLOs (6)

SLOs Service (9)

Entities (2)

Usage Examples

# 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

Exit Codes

Gotchas

• Authentication uses raw API key header: Authorization: <key> — no Bearer prefix. Using Bearer will cause 401 errors.
• The API key is region-specific. A key provisioned in US2 will return 401 against EU2 endpoints. Always confirm your key's region.
• On macOS, Python's default SSL certificates may be missing. The script uses certifi as a fallback automatically, but if you see SSL errors, run: pip install certifi.
• POST/PUT bodies must be valid JSON strings passed via --body. Invalid JSON will fail at the client, not the API.
• Some endpoints return 501 (Not Implemented) or 404 — these are server-side limitations, not client bugs.
• The --max-output flag truncates the JSON response. If you get truncated data, increase the limit or omit the flag.

Reference

See references/ALERT_SCHEMAS.md for key request/response schemas. See coralogix-core skill for authentication, region config, and connectivity checks.