Skip to main content
PATCH
/
schedules
/
{id}
/
toggle
curl --request PATCH \ --url https://cronho.st/api/v1/schedules/{id}/toggle \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' { "enabled": true } '
{
  "data": {
    "id": "schedule_123",
    "name": "Daily Health Check",
    "cronExpression": "0 9 * * *",
    "timezone": "America/New_York",
    "endpoint": "https://api.example.com/health",
    "httpMethod": "GET",
    "isEnabled": true,
    "nextRunAtUtc": "2024-01-15T14:00:00.000Z",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-14T14:00:00.000Z",
    "maxRetries": 3,
    "timeoutSeconds": 30,
    "description": "Check API health every day at 9 AM",
    "body": "{\"key\": \"value\"}",
    "headers": "{\"User-Agent\": \"Cronhost-Monitor\", \"Content-Type\": \"application/json\"}",
    "lastRunAtUtc": "2024-01-14T14:00:00.000Z"
  },
  "success": true,
  "message": "Schedule enabled successfully"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from the Cronhost dashboard.

Path Parameters

id
string
required

Unique schedule identifier

Example:

"schedule_123"

Body

application/json
enabled
boolean
required

Whether to enable (true) or disable (false) the schedule

Response

Schedule toggled successfully

data
object
required
success
boolean
required
Example:

true

message
string
required
Example:

"Schedule enabled successfully"