v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
VPS: Virtual machine

Set hostname

Set hostname for a specified virtual machine.

Changing hostname does not update PTR record automatically. If you want your virtual machine to be reachable by a hostname, you need to point your domain A/AAAA records to virtual machine IP as well.

Use this endpoint to configure custom hostnames for VPS instances.

put/api/vps/v1/virtual-machines/{virtualMachineId}/hostname

Path parameters

virtualMachineIdinteger required
Example:1268054

Virtual Machine ID

Request body

hostnamestring required

Example request

{
  "hostname": "my.server.tld"
}

Response

Success response

idinteger

Action ID

namestring

Action name

state'success' | 'error' | 'delayed' | 'sent' | 'created'

Action state

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": 8123712,
  "name": "action_name",
  "state": "success",
  "created_at": "2025-02-27T11:54:00Z",
  "updated_at": "2025-02-27T11:58:00Z"
}