v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB
Virtual Machines

Update VM note

Replace an existing note's content.

Unlike PUT (which creates the note if missing), PATCH returns 404 when no note exists yet for this scope. Use this when you want to fail loudly if the note isn't there — i.e. when you intend to edit, not create.

For "create or replace" semantics use PUT /api/v1/vms/{id}/notes/{type}. For appending without losing existing content use POST /api/v1/vms/{id}/notes/{type}/append.

patch/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

contentstring required

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

Response

Note updated

successboolean