arcodash
Start free trial
PlatformConnectorsPricingSecurityDocs
Sign inStart free trial
api reference

Schedules

Recurring execution schedules attached to a query or monitor.

GET/api/schedules

List schedules. Pass both entity_type and entity_id for a single targeted schedule, or omit both to list every schedule the caller can view.

ParamTypeRequiredDescription
entity_typestringNo"query" or "monitor". Must be supplied together with entity_id.
entity_idintegerNoThe entity's id.

Response

[
  {
    "id": 3,
    "entity_type": "query",
    "entity_id": 42,
    "spec": { "type": "cron", "cron": "0 * * * *" },
    "timezone": "UTC",
    "enabled": true,
    "overlap_policy": "skip",
    "next_run_at": "2026-07-17T13:00:00Z",
    "consecutive_failures": 0,
    "last_run": { "status": "success", "finished_at": "2026-07-17T12:00:00Z", "duration_ms": 420, "error": null }
  }
]

POST/api/schedules

Create a schedule for a query or monitor. Returns 201.

Request

{ "entity_type": "query", "entity_id": 42, "spec": { "type": "cron", "cron": "0 * * * *" }, "timezone": "UTC" }

PATCH/api/schedules/{id}

Update spec, timezone, overlap_policy, enabled, or paused_until.

Request

{ "enabled": false }

DELETE/api/schedules/{id}

Delete a schedule. Returns 204.