Virtual Machines
Upsert VM note
Create or fully replace the personal or account note on a VM.
Behavior
This is an overwrite, not an append — the request content becomes the entire note body. To append, fetch the existing note via GET /api/v1/vms/{id}/notes first, concatenate, and PUT the combined value.
Scopes
- type: personal — one note per user per VM (unique on vm_id + user_id). Visible only to the user that wrote it.
- type: account — one note per account per VM (unique on vm_id + account_id). Visible to all account members; any member with permission can update it.
Clearing a note
Pass content: "" to set an empty note. The note row is kept (still returned by GET /notes); only the content is empty.
put/api/v1/vms/{id}/notes/{type}
Path parameters
idstring uuid required
VM ID (UUID)
type'personal' | 'account' required
Note scope. personal is visible only to the writer; account is shared across the account.
Headers
X-Project-IDstring uuid required
Project ID. Required for all mutating operations (create, delete, power actions, resize).
Request body
Response
Note saved