Playground

Playground

StorageRecord

/api/v1/storage/records

A small JSON record keyed by app + namespace.

listgetputdelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
user_idstringSet only for tier=user — the user who owns this record.
tierstringIsolation sandbox: private (app-scoped), user (user-scoped cross-app), shared (tenant-wide).
collectionstringCollection name as supplied by the SDK consumer. cpod-backend namespaces it by tenantId + appId.
keystringDocument key within the collection.
valuejsonArbitrary JSON document stored as the record's payload.
ttlnumberTTL in seconds. A MongoDB TTL index removes the document when the TTL elapses. Null means no expiry.
versionnumberOptimistic concurrency counter — incremented on every update.

API

Loading manifest…