Cron jobs API

Create a cron job

POST /cli/cronjobs

string

required

Job name shown in Pxxl.

string

required

Five-field cron expression.

string

required

HTTPS endpoint called by the job.

GET | POST | PUT | PATCH | DELETE

default:"GET"

HTTP method sent to the endpoint.

object

Request headers sent by Pxxl.

number

Maximum execution time.

string

Associated project.

string

Owning team.

curl --request POST \
  https://server.pxxl.app/api/v3/cli/cronjobs \
  --header "Authorization: Bearer $PXXL_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"nightly cleanup","schedule":"0 2 * * *","url":"https://api.example.com/jobs/cleanup","method":"POST","timeoutSeconds":30}'

{
  "id": "cron_123",
  "name": "nightly cleanup",
  "schedule": "0 2 * * *",
  "url": "https://api.example.com/jobs/cleanup",
  "method": "POST",
  "timeoutSeconds": 30,
  "status": "active",
  "consecutiveFailures": 0,
  "lastRunAt": null,
  "nextRunAt": "2026-08-18T02:00:00Z"
}

Cron endpoints

Method	Path	Parameters	Returns
`GET`	`/cli/cronjobs`	`teamId?`	`{ cronJobs }`
`POST`	`/cli/cronjobs`	Creation body above, `teamId?`	Cron job
`GET`	`/cli/cronjobs/{cronJobId}`	`teamId?`	Cron job
`PUT`	`/cli/cronjobs/{cronJobId}`	Editable fields, `status?`, `teamId?`	Updated cron job
`DELETE`	`/cli/cronjobs/{cronJobId}`	`teamId?`	Action result
`POST`	`/cli/cronjobs/{cronJobId}/start`	`teamId?`	Action result
`POST`	`/cli/cronjobs/{cronJobId}/stop`	`teamId?`	Action result
`POST`	`/cli/cronjobs/{cronJobId}/trigger`	`teamId?`	Accepted run result
`GET`	`/cli/cronjobs/{cronJobId}/runs`	`page?`, `limit?`, `teamId?`	Paginated runs
`POST`	`/cli/cronjobs/validate-schedule`	`{ schedule }`	Validation result
`POST`	`/cli/cronjobs/validate-url`	`{ url }`	Validation result

Trigger a run

curl --request POST \
  https://server.pxxl.app/api/v3/cli/cronjobs/cron_123/trigger \
  --header "Authorization: Bearer $PXXL_API_KEY"

{
  "success": true,
  "message": "Cron job triggered",
  "runId": "run_123",
  "status": "running"
}

Run history

{
  "runs": [
    {
      "id": "run_123",
      "cronJobId": "cron_123",
      "status": "success",
      "statusCode": 200,
      "output": "ok",
      "error": null,
      "timedOut": false,
      "startedAt": "2026-08-17T08:05:00Z",
      "finishedAt": "2026-08-17T08:05:01Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

Job headers can contain secrets. Keep cron management in trusted server code.

SDK

CLI

API

Cron jobs API

Create a cron job

Cron endpoints

Trigger a run

Run history

​Create a cron job

​Cron endpoints

​Trigger a run

​Run history

Create a cron job

Cron endpoints

Trigger a run

Run history