Schedules

A schedule runs an action on a cron expression. It lives in a project like any resource, can be paused, and records each firing as its last_execution.

curl -X POST https://api.gwenlake.com/v1/schedules \
  -H "Authorization: Bearer $GWENLAKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Nightly refresh",
    "project_id": "res.project.…",
    "trigger": {"type": "time", "cron": "0 6 * * *", "time_zone": "Europe/Paris"},
    "action": {"type": "build", "target_ids": ["res.dataset.…", "res.dataset.…"]},
    "enabled": true
  }'

The trigger

{"type": "time", "cron": "…", "time_zone": "…"}. The cron expression takes five or six fields (0 6 * * *, */15 * * * *, 0 0 1 * *). The time zone is an IANA name, UTC by default: a schedule declared in Europe/Paris fires at the local time through daylight-saving changes, and a firing that was delayed is still executed once, never twice.

The action

`action.type`	Does
`build`	builds each of `target_ids`, dependencies included: a dataset, a model, or a mediaset (which runs the sync feeding it)
`maintenance`	expires the snapshots older than `older_than_days` of each dataset in `target_ids`; a target may be a dataset, a project or an organization
`flow`	runs each of `flow_ids`

Each target is handled on its own: one bad target is reported and never stops the others.

Managing

Call	Does
`GET /schedules?project_id=`, `GET /schedules/{id}`	list, read one with its `last_execution`
`PATCH /schedules/{id}`	changes the trigger, the action or `enabled`
`POST /schedules/{id}/trigger`	fires it now, whatever the cron says
`DELETE /schedules/{id}`	removes it

From the library and the command line:

from gwenlake.schedules import build_action, time_trigger

client.schedules.create({
    "name": "Nightly refresh", "project_id": "res.project.…",
    "trigger": time_trigger("0 6 * * *", "Europe/Paris"),
    "action": build_action("res.dataset.…"),
    "enabled": True,
})
client.schedules.list(project_id="res.project.…")
client.schedules.update("res.schedule.…", {"trigger": time_trigger("*/15 * * * *")})
client.schedules.enable("res.schedule.…", False)
client.schedules.trigger("res.schedule.…")

gwenlake schedules create --project fleetsight --name "Nightly refresh" \
    --cron "0 6 * * *" --time-zone Europe/Paris --target fleetsight.aisdk_quality_by_day
gwenlake schedules update res.schedule.… --cron "*/15 * * * *"
gwenlake schedules trigger res.schedule.…

last_execution carries the time it fired, the outcome, and for a build the builds it started; the builds themselves appear in the targets’ history, with triggered_by: SCHEDULE. A schedule’s builds run with the platform’s own trust, not with a user’s credential, so a schedule keeps running when the person who set it leaves.

These endpoints are served by the platform and used by the Atlas interface; they are being opened on the public gateway progressively, and the Python library does not wrap them yet. The API reference lists what the gateway exposes today.

Get started

Concepts

Workspace

Data

Code

Build

Models

Inference

Agents

Client

Changelog

The trigger

The action

Managing

​The trigger

​The action

​Managing

The trigger

The action

Managing