Skip to main content
PATCH
/
api
/
v1
/
vms
/
{id}
/
notes
/
{type}
Update VM note
curl --request PATCH \
  --url https://api.rafftechnologies.com/api/v1/vms/{id}/notes/{type} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Project-ID: <x-project-id>' \
  --data '
{
  "content": "<string>"
}
'
{
  "success": true,
  "note": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vm_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}
Updated May 8, 2026

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)

​
type
enum<string>
required

Note scope. personal is visible only to the writer; account is shared across the account.

Available options:
personal,
account

Body

application/json
​
content
string
required

Note text. Pass an empty string to clear the note.

Response

Note updated

​
success
boolean
​
note
object

A free-form note attached to a VM. personal notes are visible only to the writer; account notes are shared across the account.

Last modified on May 8, 2026