workflow-schedules

Update a workflow schedule.

Changed on

Replaces all mutable workflow schedule fields for an existing schedule.

put/api/workflow/{agentName}/{workflowName}/schedule/{scheduleName}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workflow/{agentName}/{workflowName}/schedule/{scheduleName}
  • Auth: HTTP bearer

Path parameters

agentNamestring required

Agent name.

workflowNamestring required

Workflow name scoped to an agent.

scheduleNamestring required

WorkflowSchedule resource name.

Request body

schedulestring required
time_zonestring
timeout_secondsinteger required
suspendboolean
successful_runs_history_limitinteger
failed_runs_history_limitinteger

Response

Workflow schedule updated.

namestring required

WorkflowSchedule resource name.

agent_namestring required
workflow_namestring required

Workflow name scoped to an agent.

schedulestring required
time_zonestring
timeout_secondsinteger required
suspendboolean required
successful_runs_history_limitinteger required
failed_runs_history_limitinteger required
created_atstring date-time required

Changes