Skip to main content
GET
Get VM notes
Updated May 8, 2026

Authorizations

X-API-Key
string
header
required

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

Path Parameters

id
string<uuid>
required

VM ID (UUID)

Query Parameters

type
enum<string>

Filter to one note scope. Omit to return both.

Available options:
personal,
account

Response

VM notes

Personal and account notes for a VM. Either or both may be present.

success
boolean
required
Example:

true

personal_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.

account_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