Perform an action on a server background process

Run an action on a server-level background process.

Processing mode: async

POST /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}/actions

Perform an action on a server background process

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}/actions",
  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([
    'action' => 'restart'
  ]),
  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;
}

403

{
  "message": "<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

backgroundProcess · integer · required

The background process ID

Body

application/json

action · enum<string> · required

The action to perform on the background process.

restart Restart the background process
stop Stop the background process
start Start the background process
empty-log Empty the background process log

Available options: restart, stop, start, empty-log

Example:

"restart"

Response

202