Functions

Create a scheduler for a function

Changed on Oct 7, 2026

Creates regional scheduled invocation jobs. Requested regions must be a subset of the function's deployed regions.

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

Request

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

Path parameters

idstring uuid required

Project ID

functionIdstring uuid required

Function ID

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

Oct 7, 202623e7875e7c4c Revision changes
- ○
  the endpoint scheme security ProjectAccessToken was added to the API
Sep 19, 20263a6f365f3f35 Revision changes
- ▲
  added the new path request parameter functionId
- ▲
  added the new path request parameter id
- ▲
  added the new required request property
- ▲
  added the new required request property
- ▲
  the request's body type changed from no type to object
- ▲
  the response's body type changed from no type to object for status
- ▲
  the response's body type changed from no type to object for status
- ○
  added the new optional request property
- ○
  added the new optional request property
- ○
  added the new optional request property
- ○
  added the non-success response with the status
- ○
  added the non-success response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the optional property to the response with the status
- ○
  added the required property to the response with the status

Operation history (4 revisions)