Background Processes

Get background process

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

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

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/background-processes/:backgroundProcess/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

The organization slug

serverinteger required

The server ID

backgroundProcessinteger required

The background process ID

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.