Create site scheduled job
Scheduled Jobs
Create site scheduled job
Create a specific scheduled job for the site.
Processing mode: async
POST
Create site scheduled job
Documentation Index
Fetch the complete documentation index at: https://forge.laravel.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The organization slug
The server ID
The site ID
Body
application/json
The command to run.
Example:
"echo $(whoami)"
The user to run the scheduled job as.
Example:
"root"
The frequency of the scheduled job.
Available options:
minutely, hourly, nightly, weekly, monthly, reboot, custom Example:
"hourly"
The name of the command.
Example:
"My scheduled job"
The cron expression to use for the scheduled job. Only used if frequency is set to Custom.
Example:
"0 * * * *"
Whether a heartbeat should be created for the scheduled job.
Example:
true
The grace period, in minutes, for the heartbeat.
Available options:
1, 2, 5, 10, 30, 60 Example:
5
Response
JobResource