Create a schedule for an approved script on explicit profiles; a once schedule turns itself off after it runs.

Creates a schedule that runs an approved script on these profiles at the given times, unattended. Every profile and the script must exist; timing that would never fire is refused.

post/v1/schedules

Request

  • Base URL: http://127.0.0.1:10108
  • URL: http://127.0.0.1:10108/v1/schedules
  • Auth: HTTP bearer

Request body

concurrencyinteger
cron_exprstring

5 fields, e.g. "0 * * * *"

daily_hourinteger
daily_minuteinteger
enabledboolean
headlessboolean

Launch the run's profiles headless, without a window — the same launch as launch_profile's headless (see there): the profile's fingerprint is unchanged. Default false.

interval_minutesinteger

interval: count of interval_unit

interval_unit'minutes' | 'seconds'
namestring required
profile_idsstring[] required
run_atstring date-time

RFC 3339 with offset, e.g. 2026-10-04T09:00:00+07:00; required for once

schedule_type'interval' | 'daily' | 'weekly' | 'cron' | 'once' required
script_idstring uuid required

An approved script

stagger_msinteger
weekly_dayinteger

0 = Sunday

Response

The schedule as stored, with its next run.

concurrencyinteger required
createdAtstring date-time required
cronExprstring nullable required
dailyHourinteger nullable required
dailyMinuteinteger nullable required
enabledboolean required
headlessboolean required
idstring uuid required
intervalMinutesinteger nullable required
intervalUnit'seconds' | 'minutes' required
lastRunAtstring date-time nullable required
namestring required
nextRunAtstring date-time nullable required
profileIdsstring[] required
runAtstring date-time nullable required
scheduleType'interval' | 'daily' | 'weekly' | 'cron' | 'once' required
scriptIdstring nullable required
staggerMsinteger required
updatedAtstring date-time required
weeklyDayinteger nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.