Servers

Update bare metal service

PATCH/v1/baremetal/{id}

Renames the service; a field the body leaves out keeps its value.

curl --request PATCH \
  --url https://api.serverside.com/v1/baremetal/{id} \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2026-01-15T09:30:00Z",
    "isLocked": true,
    "isSuspended": true,
    "state": "ACTIVE",
    "primaryIpv4": "<string>",
    "primaryIpv6": "<string>",
    "bandwidth": {
      "includedEgressGb": 123
    },
    "region": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "name": "<string>",
      "city": "<string>",
      "state": "<string>",
      "countryCode": "<string>",
      "facility": "<string>",
      "rack": "<string>"
    },
    "hardware": {
      "assetId": "<string>",
      "cpuManufacturer": "INTEL",
      "cpuModel": "<string>",
      "cpuCores": 123,
      "cpuClockMhz": 123,
      "memoryGb": 123,
      "drives": [
        {
          "model": "<string>",
          "sizeBytes": 123,
          "serial": "<string>",
          "type": "UNKNOWN"
        }
      ],
      "capabilities": [
        "KVM"
      ]
    },
    "interfaces": [
      {
        "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "bondMode": "LACP",
        "physicalInterfaces": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "macAddress": "<string>",
            "speedMbps": 123,
            "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "networks": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "type": "PRIVATE",
            "managedBy": "CUSTOMER",
            "localVlanId": 123,
            "provisioningVlanId": 123,
            "isNative": true,
            "prefixes": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "createdAt": "2026-01-15T09:30:00Z",
                "cidr": "<string>",
                "gateway": "<string>",
                "subnetMask": "<string>",
                "prefixLength": 123,
                "addresses": [
                  "<string>"
                ]
              }
            ]
          }
        ]
      }
    ],
    "operatingSystem": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>",
      "deployedAt": "2026-01-15T09:30:00Z",
      "username": "<string>"
    },
    "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>"
    }
  }
}

Autorisations

Authorizationstringheaderobligatoire
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Permission requise : organization.baremetal.update

Paramètres de chemin

idstring<uuid>obligatoire

Corps

application/json

namestring | null
Limites :length 2 to 64

Réponse

200 · application/json

successbooleanobligatoire
Valeurs autorisées :true
dataobject | nullobligatoire

Autorisations

Paramètres de chemin

Corps

Réponse

Pied de page