API reference for managing scheduled tasks
Parameter | Type | Required | Description |
---|---|---|---|
endpoint_url | string | Yes | The URL to be called when the cron job executes |
frequency | string | Yes | Frequency of execution (daily, weekly, monthly, custom) |
time | string | Yes | Time of execution in 24-hour format (HH:MM) |
timezone | string | Yes | Timezone for the execution time (e.g., America/Los_Angeles) |
method | string | Yes | HTTP method to use (GET, POST, PUT, DELETE) |
headers | object | No | HTTP headers to include with the request |
body | object | No | Request body for POST/PUT methods |
day_of_week | integer | No | Day of week for weekly jobs (0-6, where 0 is Sunday) |
day_of_month | integer | No | Day of month for monthly jobs (1-31) |
custom_schedule | string | No | Cron expression for custom schedules |
Parameter | Type | Required | Description |
---|---|---|---|
status | string | No | Filter by status (active, paused) |
limit | integer | No | Maximum number of records to return (default: 20, max: 100) |
offset | integer | No | Number of records to skip (for pagination) |
Parameter | Type | Required | Description |
---|---|---|---|
id | string | Yes | The ID of the cron job |
Parameter | Type | Required | Description |
---|---|---|---|
id | string | Yes | The ID of the cron job |
Parameter | Type | Required | Description |
---|---|---|---|
id | string | Yes | The ID of the cron job |
Parameter | Type | Required | Description |
---|---|---|---|
id | string | Yes | The ID of the cron job |
Parameter | Type | Required | Description |
---|---|---|---|
id | string | Yes | The ID of the cron job |
Parameter | Type | Required | Description |
---|---|---|---|
id | string | Yes | The ID of the cron job |
Parameter | Type | Required | Description |
---|---|---|---|
status | string | No | Filter by execution status (success, failed) |
limit | integer | No | Maximum number of records to return (default: 20, max: 100) |
offset | integer | No | Number of records to skip (for pagination) |
Status Code | Description |
---|---|
400 | Bad Request - Invalid parameters |
401 | Unauthorized - Authentication failed |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource does not exist |
429 | Too Many Requests - Rate limit exceeded |
500 | Internal Server Error |