Scheduled Jobs

Create scheduled job

Create a specific scheduled job.

Processing mode: <small><code>async</code></small>

post/orgs/{organization}/servers/{server}/scheduled-jobs

Request

Base URL
https://forge.laravel.com/api
Auth
OAuth 2
Authorization codehttps://forge.laravel.com/oauth/authorize
Token URLhttps://forge.laravel.com/oauth/token
Scopesserver:view
TypeScript
https://skmtc.dev/mfullbrook/apis/forge/docs/orgs/:organization/servers/:server/scheduled-jobs/post.ts
A function with typed inputs. Its response is checked against the schema.

organizationstring required

The organization slug

serverinteger required

The server ID

namestring nullable

The name of the command.

commandstring required

The command to run.

userstring required

The user to run the scheduled job as.

cronstring nullable

The cron expression to use for the scheduled job. Only used if frequency is set to Custom.

heartbeatboolean nullable

Whether a heartbeat should be created for the scheduled job.

grace_period1 | 2 | 5 | 10 | 30 | 60

{
  "name": "My scheduled job",
  "command": "echo $(whoami)",
  "user": "root",
  "cron": "0 * * * *",
  "heartbeat": true
}

JobResource

No recorded changes to this operation across all 1 revision of this API.