schedules

Update Schedule

Update a schedule from a workflow. You cannot update the Workflow Definition, but you can update other fields.

post/workspaces/{workspace_id}/schedules/{schedule_id}

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    • API key in cookie fastapiusersauth
    • or HTTP bearer

Path parameters

workspace_idstring uuid required
schedule_idstring required

Request body

inputsobject nullable
cronstring nullable
everystring duration nullable

ISO 8601 duration string

offsetstring duration nullable

ISO 8601 duration string

start_atstring date-time nullable

ISO 8601 datetime string

end_atstring date-time nullable

ISO 8601 datetime string

status'online' | 'offline' nullable
timeoutnumber nullable

The maximum number of seconds to wait for the workflow to complete

Response

Successful Response

idstring required
workspace_idstring uuid required
created_atstring date-time required
updated_atstring date-time required
workflow_idstring required
inputsobject nullable
cronstring nullable
everystring duration nullable
offsetstring duration nullable
start_atstring date-time nullable
end_atstring date-time nullable
timeoutnumber nullable
status'online' | 'offline' required

Changes

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