MFmfullbrook
Background Processes

List background processes

List all background processes on the server.

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

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

Request

Path parameters

organizationstring required

The organization slug

serverinteger required

The server ID

Query parameters

sortstring

Available sorts are user. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -user.

page[size]integer

The number of results that will be returned per page.

page[cursor]string

The cursor to start the pagination from.

filter[user]string
Example:forge

The user that the process is running as.

filter[site_id]string

The site ID that the process is running for.

filter[directory]string
Example:/home/forge/forge.laravel.com

The directory that the process is running in.

Response

Paginated set of 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.