Get Laravel Octane integration status

Show whether Laravel Octane integration is enabled.

Processing mode: sync

GET /orgs/{organization}/servers/{server}/sites/{site}/integrations/octane

Get Laravel Octane integration status

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/integrations/octane",
  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;
}

200

{
  "data": {
    "id": "<string>",
    "type": "octaneIntegrations",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "attributes": {
      "enabled": "<string>",
      "octane_installed": true,
      "port": 123
    },
    "relationships": {
      "backgroundProcess": {
        "data": {
          "type": "backgroundProcesses",
          "id": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "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"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

FlowAuthorization Code

Authorization URL

https://forge.laravel.com/oauth/authorize

Token URL

https://forge.laravel.com/oauth/token

Scopes1

server:view

Allow members to view servers

Path Parameters

organization · string · required

The organization slug

server · integer · required

The server ID

site · integer · required

The site ID

Response

200

application/vnd.api+json

OctaneIntegrationResource

data · OctaneIntegrationResource · object · required

Show child attributes

included · BackgroundProcessResource · object[]

Show child attributes