Servers

Rename bare metal service

PUT/v1/services/baremetal/{id}

curl --request PUT \
  --url https://api.serverside.com/v1/services/baremetal/{id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2026-01-15T09:30:00Z",
    "locked": true,
    "suspended": true,
    "state": "PENDING_SETUP",
    "primaryIpv4": "<string>",
    "primaryIpv6": "<string>",
    "bandwidth": {
      "monthlyAllowanceGb": 123
    },
    "region": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "facility": "<string>",
      "rack": "<string>"
    },
    "hardware": {
      "assetId": "<string>",
      "cpuManufacturer": "INTEL",
      "cpuModel": "<string>",
      "cpuCores": 123,
      "cpuClockSpeed": 123,
      "memoryGb": 123,
      "drives": [
        {
          "model": "<string>",
          "sizeBytes": 123,
          "serial": "<string>",
          "type": "UNKNOWN"
        }
      ],
      "capabilities": [
        "KVM"
      ]
    },
    "interfaces": [
      {
        "logicalInterfaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "physicalInterfaces": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "macAddress": "<string>",
            "interfaceSpeed": 123,
            "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "virtualNetworks": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "type": "PRIVATE",
            "prefixes": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "createdAt": "2026-01-15T09:30:00Z",
                "network": "<string>",
                "gateway": "<string>",
                "subnetMask": "<string>",
                "prefixLength": 123,
                "addresses": [
                  "<string>"
                ]
              }
            ],
            "localVlanId": 123,
            "isNative": true,
            "provisioningVlanId": 123
          }
        ]
      }
    ],
    "operatingSystem": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>",
      "deployedAt": "2026-01-15T09:30:00Z"
    },
    "operation": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "DEPLOYMENT",
      "progress": 123,
      "startedAt": "2026-01-15T09:30:00Z",
      "lastProgressAt": "2026-01-15T09:30:00Z",
      "lastProgressMessage": "<string>"
    },
    "bootMode": "LOCAL_DISK",
    "lastOperation": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "DEPLOYMENT",
      "progress": 123,
      "startedAt": "2026-01-15T09:30:00Z",
      "lastProgressAt": "2026-01-15T09:30:00Z",
      "lastProgressMessage": "<string>",
      "state": "CREATED",
      "endedAt": "2026-01-15T09:30:00Z",
      "failureCategory": "<string>"
    }
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Authorizations

X-API-KEYstringheaderrequired
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Path parameters

idstring<uuid>required

Body

application/json

namestringrequired
Limits:length 2 to 64

Response

200 · application/json

OK

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject
paginationobject