Cron Node SDK

Install the official SDK:

npm install @pxxlapp/pxxl

import { PxxlClient, isPlanGateError } from '@pxxlapp/pxxl';

const pxxl = new PxxlClient({ apiKey: process.env.PXXL_API_KEY! });

Use scope=cron, scope=cronjobs, or scope=all. Read methods work with permission=read; mutations and manual triggers require permission=read_write.

Create a Job

const job = await pxxl.createCronJob({
  name: 'cache warmer',
  schedule: '*/5 * * * *',
  url: 'https://example.com/api/warm-cache',
  method: 'POST',
  timeoutSeconds: 10,
  headers: {
    'User-Agent': 'Pxxl-Cron/1.0',
  },
});

console.log(job.id);

List and Inspect

const { cronJobs } = await pxxl.listCronJobs();
const job = await pxxl.getCronJob(cronJobs[0].id);
const runs = await pxxl.listCronJobRuns(job.id, { page: 1, limit: 20 });

Control Jobs

await pxxl.stopCronJob(job.id);
await pxxl.startCronJob(job.id);
await pxxl.triggerCronJob(job.id);
await pxxl.deleteCronJob(job.id);

Validate Inputs

await pxxl.validateCronSchedule('*/5 * * * *');
await pxxl.validateCronURL('https://example.com/job');

Pxxl accepts 5-field cron expressions, public http or https URLs, and GET, POST, PUT, PATCH, or DELETE. Private and reserved IP targets are blocked before a job is saved.

Plan Limit Errors

If your account exceeds the cron job limit, the SDK throws PxxlAPIError with structured details:

try {
  await pxxl.createCronJob({
    name: 'extra job',
    schedule: '*/5 * * * *',
    url: 'https://example.com/job',
  });
} catch (error) {
  if (isPlanGateError(error)) {
    console.log(error.code, error.limit, error.current, error.requiredPlan);
  }
}

Get Started

Projects

Deploy

Regions

Storage

Database

MCP

Domains

Cron Jobs

Troubleshooting

Cron Node SDK

Create a Job

List and Inspect

Control Jobs

Validate Inputs

Plan Limit Errors

​Create a Job

​List and Inspect

​Control Jobs

​Validate Inputs

​Plan Limit Errors

Create a Job

List and Inspect

Control Jobs

Validate Inputs

Plan Limit Errors