Skip to main content
GET
/
orgs
/
{organization}
/
servers
/
{server}
/
background-processes
List background processes
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/background-processes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
{
  "data": [
    {
      "id": "<string>",
      "type": "backgroundProcesses",
      "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"
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization
string
required

The organization slug

server
integer
required

The server ID

Query Parameters

sort
string

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
default:30

The number of results that will be returned per page.

page[cursor]
string

The cursor to start the pagination from.

filter[user]
string

The user that the process is running as.

Examples:

"forge"

filter[site_id]
string

The site ID that the process is running for.

Examples:

1

filter[directory]
string

The directory that the process is running in.

Examples:

"/home/forge/forge.laravel.com"

Response

Paginated set of BackgroundProcessResource

data
BackgroundProcessResource · object[]
required
meta
object
required
I