Vaults

Register or fetch a vault by client_id (idempotent)

Used by the plugin on first sync. Returns 201 with status: created for a new vault, or 200 with status: existing when the client_id already maps to one.

post/api/vaults/register

Request

  • Base URL: https://api.engram.page
  • URL: https://api.engram.page/api/vaults/register
  • Auth: HTTP bearer

Request body

client_idstring required

Client-generated stable vault id.

namestring required

Example request

{
  "client_id": "obsidian-9f1b2c3d4e5f",
  "name": "My Vault"
}

Response

Existing vault

attachment_countinteger
created_atstring date-time nullable
deleted_atstring date-time nullable
encryptedboolean

Always true — vaults are encrypted at rest.

idstring uuid required
is_defaultboolean
namestring required
note_countinteger
populatedboolean

True once the vault holds a note other than the seeded welcome note (the moment the vault_populated event fires).

purge_atstring date-time nullable

When a soft-deleted vault is hard-purged (deleted_at + 30d).

slugstring nullable
status'created' | 'existing'

Changes

No recorded changes to this operation across all 1 revision of this API.