Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
The name of the background process.
Example:
"Custom command runner"
The command to run.
Example:
"php artisan custom:command"
The user to run the background process as.
Available options:
root, forge Example:
"forge"
The number of processes to run.
Required range:
x >= 1Example:
1
The directory to run the background process from.
Example:
"/home/forge/my-site.com/current/"
The number of seconds to wait before starting the process.
Required range:
x >= 0Example:
10
The number of seconds to wait before stopping the process.
Required range:
x >= 0Example:
10
The signal to send to stop the process.
Example:
"SIGTERM"
Response
BackgroundProcessResource