Sign in

v2

latestOpenAPI 3.1.02026-07-31822441.6 KB

Toggle schedule

Disable, enable, and manage schedules across tenants in your environment

put/tenants/{env_id}/schedule

Path parameters

env_idstring required

ID of environment

Query parameters

mode'upsert'

By default, the toggle endpoint only applies to tenants who already have (or had) schedules. Passing ?mode=upsert will apply schedules to tenants whether or not they currently have schedules

Request body

toggle'enable' | 'disable'

Used to toggle all schedules in this environment

flowsstring[]

List of flow ids to apply this operation for

tenantsstring[]

List of tenants to apply this operation for

expressionstring

Can be "default" to use the admin schedule or a cron expression. Will be applied for all tenants

Response

200

togglestring
updatedinteger

Example response

{
  "toggle": "enable",
  "updated": 1
}