Cron API
Scheduled job management
REST API endpoints for Cron. 7 operations.
List cron schedules
GET /v1/cron/schedulesReturns all scheduled jobs for the caller's project.
Auth: Bearer API key
Responses
| Status | Description |
|---|---|
200 | Schedule list |
401 | Missing or invalid API key |
500 | Internal error |
operationId: listCronSchedules
Create a cron schedule
POST /v1/cron/schedulesCreates a new scheduled job.
Auth: Bearer API key
Request body
application/json (required) — schema object.
Responses
| Status | Description |
|---|---|
201 | Schedule created |
401 | Missing or invalid API key |
500 | Internal error |
operationId: createCronSchedule
Delete a cron schedule
DELETE /v1/cron/schedules/{id}Removes a scheduled job by id.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Schedule id |
Responses
| Status | Description |
|---|---|
200 | Schedule deleted |
401 | Missing or invalid API key |
500 | Internal error |
operationId: deleteCronSchedule
Get a cron schedule
GET /v1/cron/schedules/{id}Returns a single scheduled job by id.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Schedule id |
Responses
| Status | Description |
|---|---|
200 | Schedule details |
401 | Missing or invalid API key |
500 | Internal error |
operationId: getCronSchedule
Update a cron schedule
PUT /v1/cron/schedules/{id}Updates an existing scheduled job.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Schedule id |
Request body
application/json (required) — schema object.
Responses
| Status | Description |
|---|---|
200 | Schedule updated |
401 | Missing or invalid API key |
500 | Internal error |
operationId: updateCronSchedule
List schedule executions
GET /v1/cron/schedules/{id}/executionsReturns the execution history of a scheduled job.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Schedule id |
Responses
| Status | Description |
|---|---|
200 | Execution history |
401 | Missing or invalid API key |
500 | Internal error |
operationId: listCronExecutions
Trigger a cron schedule
POST /v1/cron/schedules/{id}/triggerRuns a scheduled job immediately, outside its normal schedule.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Schedule id |
Responses
| Status | Description |
|---|---|
200 | Schedule triggered |
401 | Missing or invalid API key |
500 | Internal error |
operationId: triggerCronSchedule