Skip to main content
PATCH
/
api
/
v1
/
vms
/
{id}
/
rename
Rename VM
curl --request PATCH \
  --url https://api.raffcomputing.com/api/v1/vms/{id}/rename \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Project-ID: <x-project-id>' \
  --data '
{
  "name": "<string>"
}
'
{
  "success": true,
  "message": "Operation completed successfully"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Headers

​
X-Project-ID
string<uuid>
required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Path Parameters

​
id
string<uuid>
required

VM ID (UUID)

Body

application/json
​
name
string
required

New name for the virtual machine

Response

VM renamed

​
success
boolean
Example:

true

​
message
string
Example:

"Operation completed successfully"