REST API Reference

Authenticated endpoints require a Bearer API key. Plan features still apply where the app enforces them; this is not the retired Free/Pro/Team table.

SDK transport: REST vs. MCP

Not every Crontinel SDK talks to this REST API directly. Two SDKs use a different transport:

• REST to /api/v1 — crontinel/php, crontinel/go, crontinel/rust, @crontinel/node, and crontinel/python send plain HTTPS requests to the endpoints documented on this page.
• MCP protocol — crontinel/ruby and crontinel/cli instead speak the Model Context Protocol, using notify/* notifications and tools/call requests over the MCP transport rather than calling /api/v1 REST routes directly.

Both transports report the same underlying data (runs, alerts, status), so nothing in this split changes what you can monitor — it only changes what’s on the wire. If you’re switching between SDKs and a request you expected to see in HTTP logs isn’t there, check whether that language’s SDK uses the MCP transport instead.

Authentication

Pass your API key as a Bearer token:

Authorization: Bearer your-api-key

Or as a header:

X-Api-Key: your-api-key

Base URL

https://app.crontinel.com/api/v1

Ingest endpoints

Ingest endpoints take the app ingest key as a Bearer token. They work from any runtime over plain HTTPS. No SDK or framework header is checked.

POST /ingest/cron

Record one job run. See start and finish receipts.

Field	Required	Notes
command	yes	Any string, up to 255 characters. Not limited to artisan commands.
status	yes	running, completed, failed, or late.
started_at	yes	ISO 8601. Must not be more than five minutes in the future.
finished_at	no	ISO 8601, not before started_at.
exit_code, duration_ms, output	no
request_key	no	Reuse across the running and final receipts of one run.
job_name, environment, expression	no	Stable identity for rules.
outcomes.metrics	no	Up to 20 finite numbers, for example processed_records.
outcomes.timestamps	no	Up to 20 ISO 8601 timestamps.

POST /ingest/schedule

Register the jobs you expect. See register expected jobs.

POST /ingest/event

Record a custom event: type (not ping), severity (info, warning, critical, resolved), optional payload and occurred_at.

POST /ingest/ping

Package heartbeat with optional Horizon and queue snapshots. HTTP-only apps do not need it, and an app that has never sent a ping gets no app heartbeat alert.

Read endpoints

GET /apps

List all apps for the authenticated team.

Response:

{
  "data": [
    {
      "name": "My App",
      "slug": "my-app",
      "status": "healthy",
      "last_ping_at": "2026-04-06T12:00:00Z"
    }
  ]
}

GET /apps/{slug}/status

Full health snapshot for an app.

Response:

{
  "app": {"name": "My App", "slug": "my-app"},
  "status": "healthy",
  "horizon": {"status": "running", "paused": false, "failed_per_minute": 0.2},
  "queues": [{"name": "default", "depth": 5, "failed": 0}],
  "active_alerts": [],
  "last_updated": "2026-04-06T12:00:00Z"
}

GET /apps/{slug}/cron-runs

Last 50 cron runs, newest first.

Response:

{
  "data": [
    {
      "command": "php artisan inspire",
      "status": "completed",
      "exit_code": 0,
      "duration_ms": 145,
      "started_at": "2026-04-07T08:00:02Z"
    }
  ]
}

Field	Type	Notes
command	string	The artisan or shell command
status	string	completed, failed, running, or late
exit_code	int | null	Process exit code (null if still running)
duration_ms	int | null	Execution time in milliseconds
started_at	string	ISO 8601 timestamp

GET /apps/{slug}/alerts

Active (unresolved) alerts for the app.

Response:

{
  "data": [
    {
      "alert_key": "queue:default:depth",
      "fired_at": "2026-04-07T07:55:00Z",
      "fire_count": 3
    }
  ]
}

Field	Type	Notes
alert_key	string	Unique key like horizon:paused, queue:default:depth, cron:send-invoices:failed
fired_at	string	When the alert first fired
fire_count	int	How many times the condition was re-evaluated as firing

OpenAPI spec

Download the full spec at:

https://app.crontinel.com/openapi.json