Create automation rule

Creates a new automation rule. Set rule_type to 'trigger' for condition-based rules or 'schedule' for time-based rules.

Authorization

authorization<token>

Use your API key here.

In: header

Request Body

application/jsonRequired

nameRequiredstring

Minimum length: 1

rule_typeRequiredstring

Value in: "trigger" | "schedule"

site_idsRequiredarray<string>

statusstring

Default: "enabled"Value in: "enabled" | "disabled"

filterRequiredobject

conditionobject

scheduleobject

frequencystring

Default: "every_15_min"Value in: "every_5_min" | "every_15_min" | "every_hour"

actionsRequiredarray<object>

stop_conditionobject

Optional stop condition. PATCH semantics: omit the field to leave both sub-fields unchanged; send null for the whole object to clear both; send null for a single sub-field to clear just that one; send a number to set it. period_minutes maps 1:1 to the underlying cooldownMinutes (no lossy conversion).

curl -X POST "https://app.luxor.tech/api/v2/commander/automation/rules" \
  -H "authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Miner Overheat Alert",
    "rule_type": "trigger",
    "site_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "status": "enabled",
    "filter": {
      "apply_to_all": false,
      "combinator": "AND",
      "groups": []
    },
    "condition": {
      "type": "metric",
      "metric": "site_id",
      "operator": ">",
      "value": "string"
    },
    "schedule": {
      "cron": "0 19 * * *",
      "timezone": "America/Chicago"
    },
    "frequency": "every_5_min",
    "actions": [
      {
        "action_type": "Reboot",
        "params": {}
      }
    ],
    "stop_condition": {
      "max_executions": 0,
      "period_minutes": 0
    }
  }'

Default Response

{
  "id": "r-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "url": "/v2/commander/automation/rules/r-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Create automation rule

Authorization

Request Body

Response

TypeScript