Rescheduling a flow
This documentation describes the options available for changing the scheduler settings after a flow is deployed.
- Change the scheduler settings within the flow settings and then save the flow and redeploy the package containing that flow.
- There are two REST endpoints that can be used to modify the scheduler for a flow, or to unschedule the flow so that it no longer runs automatically. These REST endpoints are described here:
REST endpoint 1
POST {host}:{port}/hip-rest/v2/schedule/{path} where {path} is the “URL Path” field for the flow in the package definition which is the name of the flow by default. The body of this POST can include a JSON representation of the scheduler properties. In addition to modifying an existing schedule, this API can be used to schedule a flow that was not originally scheduled.
{
"start": "12:00",
"duration": "10",
"days": [1,3,7],
"unit": "hours",
"interval": 2,
"end": "20:00",
"timezone": "GMT",
"skipifbusy": true,
"end_date": " 2025-11-18"
}
REST endpoint 2
DELETE {host}:{port}/hip-rest/v2/schedule/{path} where {path} is the “URL Path” field for the flow in the package definition which is the name of the flow by default. Calling this will stop a scheduled flow from executing automatically until its schedule is set again. It has no effect on a flow that is not currently scheduled.