Update server

Update a server’s details such as name, IP address, timezone, and tags.

Processing mode: sync

PUT /orgs/{organization}/servers/{server}

Update 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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'production-web-01',
    'ip_address' => '192.168.1.1',
    'private_ip_address' => '10.0.0.1',
    'timezone' => 'America/New_York',
    'tags' => [
        'production',
        'web'
    ]
  ]),
  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;
}

200

{
  "data": {
    "id": "<string>",
    "type": "servers",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "attributes": {
      "id": 123,
      "credential_id": 123,
      "name": "<string>",
      "slug": "<string>",
      "type": "app",
      "ubuntu_version": "<string>",
      "ssh_port": 123,
      "provider": "<string>",
      "identifier": "<string>",
      "size": "<string>",
      "region": "<string>",
      "php_version": "<string>",
      "php_cli_version": "<string>",
      "opcache_status": "<string>",
      "database_type": "<string>",
      "db_status": "<string>",
      "redis_status": "<string>",
      "ip_address": "<string>",
      "private_ip_address": "<string>",
      "revoked": true,
      "created_at": "2025-07-29T09:00:00Z",
      "updated_at": "2025-07-30T09:00:00Z",
      "connection_status": "<string>",
      "timezone": "<string>",
      "local_public_key": "<string>",
      "is_ready": true
    },
    "relationships": {
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "<string>"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "tags",
      "attributes": {
        "name": "<string>",
        "created_at": "2025-07-29T09:00:00Z",
        "updated_at": "2025-07-30T09:00:00Z"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Scopes

server:manage-meta

Allow members to change server settings such as name and IP address

Path Parameters

organization · string · required

The organization slug

server · integer · required

The server ID

Body

application/json

name · string

The name of the server.

Example:

"production-web-01"

ip_address · string

The IP address of the server.

Example:

"192.168.1.1"

private_ip_address · string

The private IP address of the server.

Example:

"10.0.0.1"

timezone · string

The timezone of the server.

Example:

"America/New_York"

tags · string[]

The tags of the server.

Example:

["production", "web"]

Response

200

application/vnd.api+json

ServerResource

data · ServerResource · object · required

Show child attributes

included · TagResource · object[]

Show child attributes