Skip to main content
POST
/
orgs
/
{organization}
/
servers
/
{server}
/
sites
/
{site}
/
integrations
/
laravel-maintenance
Create Laravel Maintenance integration
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => 503,
    'secret' => 'my-secret-phrase',
    'redirect' => 'https://example.com/maintenance'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
{
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://forge.laravel.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

​
site
integer
required

The site ID

Body

application/json
​
status
enum<integer>
required

The HTTP status code that should be returned while in maintenance mode.

Available options:
304,
307,
410,
503
Example:

503

​
secret
string | null

The secret phrase that allows access to the application while in maintenance mode.

Example:

"my-secret-phrase"

​
redirect
string | null

The redirect URL to which all requests should be sent while in maintenance mode.

Example:

"https://example.com/maintenance"

Response