MFmfullbrook
Background Processes

Create background process

Create a new background process from a template.

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

post/orgs/{organization}/servers/{server}/background-processes

Request

Path parameters

organizationstring required

The organization slug

serverinteger required

The server ID

Request body

namestring required

The name of the background process.

site_idinteger

The site to associate the background process with.

commandstring required

The command to run.

user'root' | 'forge' required

The user to run the background process as.

directorystring nullable

The directory to run the background process from.

processesinteger required

The number of processes to run.

startsecsinteger

The number of seconds to wait before starting the process.

stopwaitsecsinteger

The number of seconds to wait before stopping the process.

stopsignalstring nullable

The signal to send to stop the process.

Example request

{
  "name": "Custom command runner",
  "site_id": 12345,
  "command": "php artisan custom:command",
  "user": "forge",
  "directory": "/home/forge/my-site.com/current/",
  "processes": 1,
  "startsecs": 10,
  "stopwaitsecs": 10,
  "stopsignal": "SIGTERM"
}

Response

BackgroundProcessResource

Example response

{
  "data": {
    "attributes": {
      "command": "php artisan queue:work database",
      "user": "forge",
      "directory": "/home/forge/forge.laravel.com",
      "processes": 3,
      "status": "running",
      "created_at": "2025-07-29T09:00:00Z"
    }
  }
}

Changes

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