REST API Reference

Developer

All Cronix PRO REST endpoints use the cronix-pro/v1 namespace. Requests from the WordPress admin use standard cookie + nonce authentication. Requests from external systems use Bearer token authentication (External REST API addon required).

The base URL for all endpoints is https://yoursite.com/wp-json/cronix-pro/v1/. Replace yoursite.com with your actual domain.

#Core Endpoints

Method Endpoint Description
GET /events List all registered events
POST /events Create a new event
GET /events/{hook} Get details for a specific event
POST /events/{hook}/run Execute an event immediately
POST /events/{hook}/pause Pause an event
POST /events/{hook}/resume Resume a paused event
DELETE /events/{hook} Delete an event
GET /log Query the execution log (paginated)
POST /log/clear Clear log entries
GET /health/score Get current health score and factor breakdown
GET /schedules List available recurrence schedules
POST /schedules/custom Create a custom schedule
GET /settings Read plugin settings
POST /settings Write plugin settings
GET /addons List addon states

#Tool Endpoints

Method Endpoint Description
POST /tools/safe-mode Toggle safe mode on or off
GET /tools/orphans Detect orphaned hooks
POST /tools/orphans/cleanup Remove orphaned hooks
GET /tools/duplicates Detect duplicate events
POST /notifications/test Send a test notification to a channel
GET /live-feed SSE stream of live execution events

#Authentication

Admin context (internal): Standard WordPress REST authentication - cookie session + X-WP-Nonce header, or an Application Password.

External API addon: Bearer token in the Authorization header:

Authorization: Bearer your-api-token

Use Application Passwords for server-to-server integrations where you want to leverage WordPress built-in credential management. Use the External REST API addon tokens when you need scope control (read-only vs read-write).

#Addon Endpoints

Addon-specific endpoints are only registered when the corresponding addon is enabled. Endpoints for disabled addons return 404.

See the documentation for each addon for its specific routes.

#Pagination

List endpoints accept ?page=N&per_page=N query parameters. The response includes X-WP-Total and X-WP-TotalPages headers.

#Error Responses

All errors return a standard WordPress REST error format:

{
  "code": "cronix_event_not_found",
  "message": "No event registered with that hook name.",
  "data": { "status": 404 }
}

Last updated

Was this article helpful?

FIND THE ONE THAT FITS YOUR PROJECT

Import a demo, swap the content, adjust the layout. Modern WordPress under the hood, fast even when the site fills up.