Sign in
Durable Functions

Create a scheduler for a durable function

Changed on

Each tick starts an execution rather than invoking the function, under an execution name derived from the run, so a retried tick resolves to the execution it already started. Requested regions must be a subset of the function's deployed regions.

A tick draws on the same durable allowances and concurrency cap a manual start does, and a tick that would exceed the cap fails that run.

post/projects/{id}/durable-functions/{functionId}/schedulers

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/durable-functions/{functionId}/schedulers
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Project ID

functionIdstring required

Durable function ID, or its name within the project

Request body

namestring required
enabledboolean
payloadobject
regionsstring[]

Optional single explicit deployed region. If omitted, the scheduler chooses one deployed region and invokes according to the cron expression.

Example request

{
  "schedule": {
    "cron_expression": "*/5 * * * *"
  }
}

Response

Scheduler created

idstring uuid
project_idstring uuid
function_idstring uuid
function_kind'standard' | 'durable'

Which kind of function this is. standard runs once per invocation. durable checkpoints its progress and resumes from the last completed step, and is invoked asynchronously through its own executions collection. A function's kind is fixed when it is created and cannot be changed afterwards. Omitting this field means standard.

namestring
enabledboolean
schedule_kind'cron'
cron_expressionstring
payloadobject
regionsstring[]
regions_explicitboolean
next_run_atstring date-time
last_started_atstring date-time
last_completed_atstring date-time
last_errorstring
run_countinteger

Total number of times this scheduler has executed. 0 for a scheduler that has never run.

created_atstring date-time
updated_atstring date-time

Changes