Rename and tag

PATCH/api/v1/vms/{vm_uuid}

Changes the name or the tags. Tags replace all the tags the server had.

Parameters

Name	In	Description
vm_uuid	path, stringrequired	Server id, from Create a VM or List VMs

Request body

Field	Type	Description
display_name	string, optional	New name of the server
tags	map of string, optional	Your tags; replace all the tags it had, up to 10

Example request

curl -X PATCH "https://platform.serverscamp.com/api/v1/vms/$VM_UUID" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "web-prod-1"
  }'

import os, requests

token = os.environ["API_TOKEN"]
vm_uuid = "6f1c2a9e-4b3d-4e8a-9c71-2d5e8f0a1b34"
r = requests.patch(
    f"https://platform.serverscamp.com/api/v1/vms/{vm_uuid}",
    headers={"Authorization": f"Bearer {token}"},
    json={
      "display_name": "web-prod-1"
    },
)
r.raise_for_status()
print(r.json())

const vmUuid = '6f1c2a9e-4b3d-4e8a-9c71-2d5e8f0a1b34';
const r = await fetch(`https://platform.serverscamp.com/api/v1/vms/${vmUuid}`, {
  method: 'PATCH',
  headers: { Authorization: `Bearer ${process.env.API_TOKEN}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "display_name": "web-prod-1"
  }),
});
console.log(r.status, await r.json());

curl -X PATCH "https://platform.serverscamp.com/api/v1/vms/$VM_UUID" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "tags": {
      "env": "production",
      "team": "web"
    }
  }'

import os, requests

token = os.environ["API_TOKEN"]
vm_uuid = "6f1c2a9e-4b3d-4e8a-9c71-2d5e8f0a1b34"
r = requests.patch(
    f"https://platform.serverscamp.com/api/v1/vms/{vm_uuid}",
    headers={"Authorization": f"Bearer {token}"},
    json={
      "tags": {
        "env": "production",
        "team": "web"
      }
    },
)
r.raise_for_status()
print(r.json())

const vmUuid = '6f1c2a9e-4b3d-4e8a-9c71-2d5e8f0a1b34';
const r = await fetch(`https://platform.serverscamp.com/api/v1/vms/${vmUuid}`, {
  method: 'PATCH',
  headers: { Authorization: `Bearer ${process.env.API_TOKEN}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "tags": {
      "env": "production",
      "team": "web"
    }
  }),
});
console.log(r.status, await r.json());

Answer

Status 200 with this body.

Field	Type	Description
vm_uuid	stringrequired	Server id
display_name	string, optional	Name given at create
vm_name	stringrequired	System name, also the DNS name of the server
status	stringrequired	pending while it is created, then active; deleting, reinstalling and resizing while those run; failed or error when something went wrong
state	string, optional	Power state: running, stopped and the like
error	string, optional	What went wrong, when status is failed or error
pending_op	map of object, optional	A power action still running, for example {"type": "vm_power", "action": "shutdown"}; null when none is
vm_class_id	integerrequired	Plan id
vm_class_name	string, optional	Plan name
cpu_cores	integerrequired	vCPU cores
memory_mb	integerrequired	Memory, MB
storage_class_id	integerrequired	Disk id of the root disk
storage_class_name	string, optional	Disk name of the root disk
disk_gb	integerrequired	Root disk size, GB
vm_template_id	integer, optional	Image the server was created with
os_type	string, optional	System of the image
ssh_key_id	integer, optional	SSH key of the scamp user
network_uuid	stringrequired	Private network of the server
network	VmNetworkInforequired
network.network_uuid	string, optional	Private network of the server
network.ip_internal	string, optional	Private IPv4 address in that network
network.ipv6_address	string, optional	IPv6 address
network.public_ip_v4	string, optional	Public IPv4 address of the server, if it has one
network.public_ip_v6	string, optional	Public IPv6 address of the server, if it has one
network.floating_ip_v4	string, optional	Floating IPv4 attached to the server
network.floating_ip_v6	string, optional	Floating IPv6 attached to the server
os_user	stringrequired	User to log in as: scamp, with sudo
os_password	stringrequired	Password of that user
tags	map of stringrequired	Your tags
created_at	stringrequired	When it was created, ISO 8601

{
  "vm_uuid": "6f1c2a9e-4b3d-4e8a-9c71-2d5e8f0a1b34",
  "display_name": "web-prod-1",
  "vm_name": "web-1-k3x9",
  "status": "active",
  "state": "running",
  "error": null,
  "pending_op": null,
  "vm_class_id": 49,
  "vm_class_name": "basic-4g",
  "cpu_cores": 2,
  "memory_mb": 4096,
  "storage_class_id": 18,
  "storage_class_name": "standard",
  "disk_gb": 50,
  "vm_template_id": 5,
  "os_type": "Ubuntu",
  "ssh_key_id": 42,
  "network_uuid": "a3e1f0c2-7d4b-4c6e-8f9a-0b1c2d3e4f50",
  "network": {
    "network_uuid": "a3e1f0c2-7d4b-4c6e-8f9a-0b1c2d3e4f50",
    "ip_internal": "10.0.0.12",
    "ipv6_address": "2a01:ea05:10:4::12",
    "public_ip_v4": "185.236.10.44",
    "public_ip_v6": "2a01:ea05:20:1::44",
    "floating_ip_v4": null,
    "floating_ip_v6": null
  },
  "os_user": "scamp",
  "os_password": "Rk7vQ2mXp9LwT4sN",
  "tags": {
    "env": "production"
  },
  "created_at": "2026-11-01T09:20:14+00:00"
}

Errors

Status	When
`401`	No token, or a token that is not valid
`404`	No such server in your account
`422`	The body or a parameter is not what the operation takes

Every operation can also answer 401 without a valid token. All errors