Chelabase
ManagementFunctions

Change a function's schedule on the branch

PATCH
/v1/databases/{id}/branches/{branch_id}/functions/{name}/schedules/{schedule_id}

Changes what the body names. A new cron or time zone, or turning the schedule on, sets its next run from now.

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Database id

Formatuuid
branch_id*string

Branch id

Formatuuid
name*string

Function name

schedule_id*string

Schedule id

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

cron?string|null
enabled?boolean|null
timezone?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/databases/497f6eca-6276-4993-bfeb-53cbbbba6f08/branches/497f6eca-6276-4993-bfeb-53cbbbba6f08/functions/string/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "cron": "string",  "enabled": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "next_run_at": "2019-08-24T14:15:22Z",  "timezone": "string"}

Add a schedule to a function on the branch POST

At each due time the function's `scheduled(controller, env, ctx)` handler runs once, with `controller.cron` and `controller.scheduledTime`, while the function is enabled on the branch. A cron has 5 fields (minute granularity); ticks missed while the worker was down run once. A new branch inherits the schedules.

Delete a function's schedule on the branch DELETE

Next Page