ScalixScalix Docs

Cron API

Scheduled job management

REST API endpoints for Cron. 7 operations.

List cron schedules

plaintext
GET /v1/cron/schedules

Returns all scheduled jobs for the caller's project.

Auth: Bearer API key

Responses

StatusDescription
200Schedule list
401Missing or invalid API key
500Internal error

operationId: listCronSchedules

Create a cron schedule

plaintext
POST /v1/cron/schedules

Creates a new scheduled job.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

StatusDescription
201Schedule created
401Missing or invalid API key
500Internal error

operationId: createCronSchedule

Delete a cron schedule

plaintext
DELETE /v1/cron/schedules/{id}

Removes a scheduled job by id.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesSchedule id

Responses

StatusDescription
200Schedule deleted
401Missing or invalid API key
500Internal error

operationId: deleteCronSchedule

Get a cron schedule

plaintext
GET /v1/cron/schedules/{id}

Returns a single scheduled job by id.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesSchedule id

Responses

StatusDescription
200Schedule details
401Missing or invalid API key
500Internal error

operationId: getCronSchedule

Update a cron schedule

plaintext
PUT /v1/cron/schedules/{id}

Updates an existing scheduled job.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesSchedule id

Request body

application/json (required) — schema object.

Responses

StatusDescription
200Schedule updated
401Missing or invalid API key
500Internal error

operationId: updateCronSchedule

List schedule executions

plaintext
GET /v1/cron/schedules/{id}/executions

Returns the execution history of a scheduled job.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesSchedule id

Responses

StatusDescription
200Execution history
401Missing or invalid API key
500Internal error

operationId: listCronExecutions

Trigger a cron schedule

plaintext
POST /v1/cron/schedules/{id}/trigger

Runs a scheduled job immediately, outside its normal schedule.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesSchedule id

Responses

StatusDescription
200Schedule triggered
401Missing or invalid API key
500Internal error

operationId: triggerCronSchedule