Luxor PlatformAPI DocumentationCommanderAutomation Rules
Get automation rules
Returns a paginated list of automation rules (triggers and schedules) with optional filtering by site, rule type, and status.
Authorization
LuxorAPIKey authorization<token>
Use your API key here.
In: header
Query Parameters
site_id?string
Format
uuidrule_type?string
Filter by rule type. Applied server-side; pagination reflects the filtered total.
Value in
- "trigger"
- "schedule"
status?string
Filter by status. Applied server-side; pagination reflects the filtered total.
Value in
- "enabled"
- "disabled"
sort_by?string
Value in
- "name"
- "created_at"
- "last_triggered_at"
- "times_triggered"
sort_order?string
Default
"desc"Value in
- "asc"
- "desc"
page_number?integer
Range
1 <= valueDefault
1page_size?integer
Range
1 <= valueDefault
25Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v2/commander/automation/rules"{ "rules": [ { "id": "r-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Miner Overheat Alert", "rule_type": "trigger", "status": "enabled", "site_ids": [ "ab580781-02e2-4a18-ac1b-8fc9be2f4ad4" ], "frequency": "every_15_min", "filter": { "apply_to_all": true, "combinator": "AND", "groups": [ { "combinator": "AND", "conditions": [ { "field": "site_id", "operator": "eq", "value": "string" } ] } ] }, "condition": { "type": "metric", "metric": "site_id", "operator": ">", "value": "string" }, "schedule": { "cron": "0 19 * * *", "timezone": "UTC" }, "actions": [ { "action_type": "Reboot", "params": {} } ], "stop_condition": { "max_executions": 0, "period_minutes": 0 }, "last_triggered_at": "2026-04-13T18:22:00Z", "times_triggered": 4, "created_at": "2026-01-10T14:30:00Z", "url": "/v2/commander/automation/rules/r-a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ], "pagination": { "page_number": 1, "page_size": 1, "item_count": 0, "previous_page_url": null, "next_page_url": null }}{ "statusCode": 400, "code": "FST_ERR_VALIDATION", "error": "Bad Request", "message": "body/end_date Required"}{ "statusCode": 400, "code": "FST_ERR_VALIDATION", "error": "Bad Request", "message": "body/end_date Required"}