Rename VPS
Update the display name of a VPS. This is a local operation only and does not affect the hosting provider.
Request
POST /api/v1/vps/{id}/rename
Required scope: vps:manage
Path Parameters
| Parameter |
Type |
Description |
id |
string |
The VPS ID |
Headers
| Header |
Required |
Value |
Authorization |
Yes |
Bearer YOUR_API_KEY |
Content-Type |
Yes |
application/json |
Request Body
| Field |
Type |
Required |
Description |
name |
string |
Yes |
New display name (1–32 characters) |
{
"name": "Production Server"
}
Response
{
"data": {
"name": "Production Server",
"success": true
}
}
Response Fields
| Field |
Type |
Description |
name |
string |
The new display name |
success |
boolean |
Whether the rename was successful |
Errors
| Status |
Code |
Description |
| 400 |
INVALID_NAME |
Name must be 1–32 characters |
| 400 |
INVALID_BODY |
Request body is not valid JSON |
| 404 |
NOT_FOUND |
VPS not found or not accessible |
Example
curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/rename" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Production Server"}'
MCP
This action is also available via the rename_vm MCP tool.