Servers

Update server

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

Processing mode: <small><code>sync</code></small>

put/orgs/{organization}/servers/{server}

Request

Path parameters

organizationstring required

The organization slug

serverinteger required

The server ID

Request body

namestring

The name of the server.

ip_addressstring

The IP address of the server.

private_ip_addressstring

The private IP address of the server.

timezonestring

The timezone of the server.

tagsstring[]

The tags of the server.

Example request

{
  "name": "production-web-01",
  "ip_address": "192.168.1.1",
  "private_ip_address": "10.0.0.1",
  "timezone": "America/New_York",
  "tags": [
    "production",
    "web"
  ]
}

Response

ServerResource

Example response

{
  "data": {
    "attributes": {
      "created_at": "2025-07-29T09:00:00Z",
      "updated_at": "2025-07-30T09:00:00Z"
    }
  },
  "included": [
    {
      "attributes": {
        "created_at": "2025-07-29T09:00:00Z",
        "updated_at": "2025-07-30T09:00:00Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.