GeniesTasks
Genie tasks
Update a Genie task
PATCH
Changes a Genie task: name, instruction, schedule (cron_expression or run_at), start time, paused or not.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
genie_id*stringThe Genie.
Format
uuidscheduled_task_id*stringThe Genie task.
Format
uuidregion*RegionsRegion of the genie: besg (Europe) or usnv (United States)
Value in
"besg""usnv"application/json- body
name?|Default
nullinstruction?|Default
nullcron_expression?|Default
nullrun_at?|Default
nullstart_time?|Default
nullis_paused?|Default
nullvalidate_only?Validate OnlyRun every check of the write and answer 204 without writing: a refused write answers the error the write would
Default
falseOK
application/json- response
A task a genie runs once (run_at) or on a cron schedule
task_id*Task Idname?|Default
nullinstruction?|What the genie is asked each time
Default
nullcron_expression?|Default
nullrun_at?|For a one-time task: when it runs, ISO 8601
Default
nullstart_time?|For a scheduled task: when the schedule starts
Default
nullnext_run_time?|Default
nullis_paused?|Default
nullis_shared_with_workspace?|Default
nullcreated_time?|Default
nullcurl -X PATCH 'https://api.stacksync.com/v1/workspaces/0/genies/497f6eca-6276-4993-bfeb-53cbbbba6f08/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08?region=besg' \ -H 'Content-Type: application/json' \ -d '{ "cron_expression": "0 9 * * 1-5"}'{ "task_id": "<task_id>", "name": "<name>", "instruction": "<instruction>", "cron_expression": "<cron_expression>", "run_at": "<run_at>", "start_time": "<start_time>", "next_run_time": "<next_run_time>", "is_paused": false, "is_shared_with_workspace": false, "created_time": "<created_time>"}