ScalixScalix Docs
Sign up

Scheduled Wake-ups

Wake persistent sandboxes on a cron schedule, at a fixed time, or on an event

Overview

Persistent sandboxes can be paused to save resources and woken automatically. A schedule attaches to an existing persistent sandbox and resumes it on a cron expression, at a fixed time, or when a named event fires. Use this for periodic data processing, report generation, or agents that only need to run at certain times.

Create a Schedule

Attach a schedule to a persistent sandbox. type is one of cron, time, or event:

bash
# Wake every day at 03:00 UTC
curl -X POST https://api.scalix.world/v1/scheduler \
  -H "Authorization: Bearer $SCALIX_API_KEY" \
  -d '{
    "sandboxId": "psbx_abc123",
    "type": "cron",
    "expression": "0 3 * * *"
  }'
 
# Wake once at a fixed time
curl -X POST https://api.scalix.world/v1/scheduler \
  -H "Authorization: Bearer $SCALIX_API_KEY" \
  -d '{
    "sandboxId": "psbx_abc123",
    "type": "time",
    "scheduledTime": "2026-07-01T09:00:00Z"
  }'
 
# Wake when an event fires
curl -X POST https://api.scalix.world/v1/scheduler \
  -H "Authorization: Bearer $SCALIX_API_KEY" \
  -d '{
    "sandboxId": "psbx_abc123",
    "type": "event",
    "eventType": "deploy.completed"
  }'

Manage Schedules

bash
# List your schedules
curl https://api.scalix.world/v1/scheduler \
  -H "Authorization: Bearer $SCALIX_API_KEY"
 
# Get the schedule for a sandbox
curl https://api.scalix.world/v1/scheduler/{sandboxId} \
  -H "Authorization: Bearer $SCALIX_API_KEY"
 
# Update (change expression, or disable without deleting)
curl -X PATCH https://api.scalix.world/v1/scheduler/{sandboxId} \
  -H "Authorization: Bearer $SCALIX_API_KEY" \
  -d '{"expression": "0 6 * * *", "enabled": true}'
 
# Skip the next run (disables the schedule until you re-enable it)
curl -X POST https://api.scalix.world/v1/scheduler/{sandboxId}/cancel \
  -H "Authorization: Bearer $SCALIX_API_KEY"
 
# Delete
curl -X DELETE https://api.scalix.world/v1/scheduler/{sandboxId} \
  -H "Authorization: Bearer $SCALIX_API_KEY"

Schedules can also be edited and skipped from the console — each scheduled task card on the Sandboxes page has Edit and Skip next run actions.

Upcoming Wake-ups

bash
curl https://api.scalix.world/v1/scheduler/upcoming \
  -H "Authorization: Bearer $SCALIX_API_KEY"

Fire an Event

Wake every sandbox subscribed to an event type:

bash
curl -X POST https://api.scalix.world/v1/scheduler/events \
  -H "Authorization: Bearer $SCALIX_API_KEY" \
  -d '{"eventType": "deploy.completed", "data": {"service": "api-server"}}'