Sign in
latestOpenAPI 3.1.02026-08-21360412711.8 KB

b29e1840a386

Update Schedule

put/v1/update-schedule/{schedule_id}

Path parameters

schedule_idstring required

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

timezonestring nullable

IANA timezone the cron expression is read in. Null means UTC.

enabledboolean nullable

Whether to enable or disable the cron job.

Response

Successful Response

idstring required

The unique identifier for the updated cron job.

simulation_idstring required

The unique identifier for the associated simulation.

cron_expressionstring required

The cron expression defining the job schedule.

enabledboolean nullable

Whether the cron job is enabled.

created_atstring required

The timestamp when the cron job was created.

timezonestring nullable

IANA timezone the cron expression is read in. Null means UTC.