Delete server

Delete a server. If preserve_at_provider is set to true, the server will only be removed from Forge and will not be deleted from the server provider.

Processing mode: async

DELETE /orgs/{organization}/servers/{server}

Delete server

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  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;
}

403

{
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

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

Scopes

server:delete

Allow members to delete servers

Path Parameters

organization · string · required

The organization slug

server · integer · required

The server ID

Query Parameters

preserve_at_provider · boolean

When set to true, the server will only be removed from Forge and will not be deleted from the server provider.

Response

202