v12

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

Get VM notes

Get the personal and account-shared notes attached to a VM.

  • Personal note — visible only to the user that wrote it.
  • Account note — visible to all members of the account.

Use the optional type query param to fetch only one scope. Either or both fields may be absent from the response if no note has been written yet — in that case only { "success": true } is returned.

get/api/v1/vms/{id}/notes

Path parameters

idstring uuid required

VM ID (UUID)

Query parameters

type'personal' | 'account'

Filter to one note scope. Omit to return both.

Response

VM notes

successboolean required

Example response

{
  "success": true
}