Upsert VM note

curl --request PUT \
  --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"
  }
}

Notes

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

vms

{id}

notes

{type}

Upsert VM note

curl --request PUT \
  --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

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 saved

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.

Show child attributes

Last modified on May 8, 2026

Get VM notes Update VM note