v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB

Agency Hosting: Cron Jobs

Create Agency Plan website cron job

Creates a cron job for an Agency Plan website from a schedule expression and a command.

Returns the created cron job, including its uuid, which is required to delete the cron job.

post/api/agency-hosting/v1/websites/{website_uid}/cron-jobs

Path parameters

website_uidstring required

Example:zpwlGlp19

Agency Plan website UID

Request body

timestring required

Cron schedule expression (standard 5-field crontab syntax).

commandstring required

Command to run on the schedule. Must not contain pipe (|) or redirection (<, >) characters.

Example request

{
  "time": "*/30 * * * *",
  "command": "php artisan schedule:run"
}

Response

Success response

uuidstring

Unique identifier of the cron job. Use it to delete the cron job.

timestring

Cron schedule expression.

commandstring

Command executed on the configured schedule.

created_atstring date-time

Cron job creation timestamp.

Example response

{
  "uuid": "01931d6f-68f5-7b72-8d9e-09c6e1e6aa0e",
  "time": "*/30 * * * *",
  "command": "php artisan schedule:run",
  "created_at": "2024-10-28T12:00:00+00:00"
}